com_maileon_api_transactions_Transaction Class Reference

Inheritance diagram for com_maileon_api_transactions_Transaction:

Public Member Functions
	__construct ()
	addAttachmentFromFile ($filename, $mimetype, $attachmentFileName=null)
	addAttachmentFromBinaryData ($filename, $mimetype, $contents)
	addAttachmentFromBase64Data ($filename, $mimetype, $contents)
	toString ()
	toArray ()
Public Member Functions inherited from com_maileon_api_json_AbstractJSONWrapper
	toArray ()
	fromArray ($object_vars)
	__toString ()
	isEmpty ()

Public Attributes
	$type
	$contact
	$import
	$content
	$attachments

Detailed Description

The wrapper class for a Maileon transaction.

Author

Viktor Balogh | Wanadis Kft. | balogh.viktor@maileon.hu

Marcus Ständer | Trusted Technologies GmbH | marcus.staender@trusted-technologies.de

Definition at line 10 of file Transaction.php.

Constructor & Destructor Documentation

com_maileon_api_transactions_Transaction::__construct

(

)

Constructor initializing default values.

Definition at line 49 of file Transaction.php.

Member Function Documentation

com_maileon_api_transactions_Transaction::addAttachmentFromFile	(		$filename,
			$mimetype,
			$attachmentFileName = null
	)

Read a binary file from the file system and adds it as an attachment to this transaction.

Parameters

	$filename	the file system path to read the attachment from
	$mimetype	the mime type of the attachment
null	$attachmentFileName	the file name to use when sending the attachment as an e-mail. If this is null, the basename of $filename is used instead.

Definition at line 64 of file Transaction.php.

com_maileon_api_transactions_Transaction::addAttachmentFromBinaryData	(		$filename,
			$mimetype,
			$contents
	)

Adds an attachment to this transaction from a string that contains binary data.

Parameters

$filename	the file name to use when sending the attachment as an e-mail
$mimetype	the mime type of the attachment
$contents	a string containing binary data, e.g. as returned from fread().

Definition at line 87 of file Transaction.php.

com_maileon_api_transactions_Transaction::addAttachmentFromBase64Data	(		$filename,
			$mimetype,
			$contents
	)

Adds an attachment to this transaction from a string that contains base64-encoded data.

Parameters

$filename	the file name to use when sending the attachment as an e-mail
$mimetype	the mime type of the attachment
$contents	a string containing binary data, e.g. as returned from fread().

Definition at line 98 of file Transaction.php.

com_maileon_api_transactions_Transaction::toString

(

)

Returns

string a human-readable representation listing all the attributes of this transaction and their respective values.

Definition at line 107 of file Transaction.php.

---

The documentation for this class was generated from the following file:

• client/com/maileon/api/transactions/Transaction.php