Maileon PHP client  1.5.5
Easily integrate your PHP application with Maileon.
com_maileon_api_transactions_Transaction Class Reference
Inheritance diagram for com_maileon_api_transactions_Transaction:
com_maileon_api_json_AbstractJSONWrapper

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.

$this->import = new com_maileon_api_transactions_ImportReference(); $this->import->contact = new com_maileon_api_transactions_ImportContactReference(); $this->import->contact->permission = com_maileon_api_contacts_Permission::$NONE;

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
$filenamethe file system path to read the attachment from
$mimetypethe mime type of the attachment
null$attachmentFileNamethe 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 67 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
$filenamethe file name to use when sending the attachment as an e-mail
$mimetypethe mime type of the attachment
$contentsa string containing binary data, e.g. as returned from fread().

Definition at line 90 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
$filenamethe file name to use when sending the attachment as an e-mail
$mimetypethe mime type of the attachment
$contentsa string containing binary data, e.g. as returned from fread().

Definition at line 101 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 110 of file Transaction.php.


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