Interface Inx_Api_Mail_MailContent

Description

The Inx_Api_Mail_MailContent contains the personalized content of a mailing for a specific recipient.

The Inx_Api_Mail_MailContent contains the personalized content of a mailing for a specific recipient. The information that can be retrieved from the Inx_Api_Mail_MailContent includes:

  • The mail type: getMailType()
  • Plain/HTML text: getPlainText() and getHtmlText()
  • The subject: getSubject()
  • The recipient address: getRecipientAddress()
  • Attachments: getAttachments()
  • Embedded images: getEmbeddedImages()
  • The sender address: getSenderAddress()
  • The bounce and reply addresses: getBounceAddress() and getReplyToAddress()
  • The mail headers: getHeader() or getMultipleHeaders()
An Inx_Api_Mail_MailContent object is created by an Inx_Api_Mail_MailingRenderer using its build methods.

  • version: $Revision: 9482 $ $Date: 2007-12-18 16:42:11 +0200 (An, 18 Grd 2007) $ $Author: vladas $
  • see: Inx_Api_Mail_MailingRenderer::build($iRecipientId, $iPreferredMailType=null)
  • deprecated: As of 1.11.10, Inx_Api_Mail_MailingRenderer has been replaced with Inx_Api_Rendering_GeneralMailingRenderer
  • since: API 1.0

Located in /Api/Mail/MailContent.php (line 31)


	
			
Class Constant Summary
Method Summary
array getAttachments ()
string getBounceAddress ()
array getHeader ()
string getHtmlText ()
int getMailType ()
string getPlainText ()
string getReplyToAddress ()
string getSenderAddress ()
string getSubject ()
Methods
getAttachments (line 116)

Returns all regular attachments (files) of the mail.

Returns all regular attachments (files) of the mail.

  • return: all regular attachments of the mail.
  • access: public
array getAttachments ()
getBounceAddress (line 109)

Returns the bounce address of the mail.

Returns the bounce address of the mail. This address will be used for bounce messages.

  • return: the bounce address of the mail.
  • access: public
string getBounceAddress ()
getEmbeddedImages (line 123)

Returns all embedded images of the mail.

Returns all embedded images of the mail.

  • return: all embedded images of the mail.
  • access: public
array getEmbeddedImages ()
getHeader (line 137)

Returns the header information of the mail.

Returns the header information of the mail. The associative array contains the key/value-pair of the headers. Note: This method allows header fields only to be defined once. If a header field is defined multiple times, the last value will be used. If you wish to define header fields multiple times, use the

  • return: the header information of the mail.
  • access: public
array getHeader ()
getHtmlText (line 66)

Returns the HTML text part of the mail, or null if the mail type is

Returns the HTML text part of the mail, or null if the mail type is Inx_Api_Mail_MailContent::MAIL_TYPE_PLAIN_TEXT

  • return: the html text part of the mail, if any.
  • access: public
string getHtmlText ()
getMailType (line 58)

Returns the mail type of this mail - either:

Returns the mail type of this mail - either:

  • Inx_Api_Mail_MailContent::MAIL_TYPE_HTML_TEXT,
  • Inx_Api_Mail_MailContent::MAIL_TYPE_PLAIN_TEXT or
  • Inx_Api_Mail_MailContent::MAIL_TYPE_MULTIPART

  • return: the mail type of this mail.
  • access: public
int getMailType ()
getMultipleHeaders (line 150)

Returns the header information of the mail.

Returns the header information of the mail. The array contains Inx_Api_Mail_HeaderField objects encapsulating the key/value-pairs of the headers. This method allows for multiple defined header fields. Note: You should be aware that defining the same header field multiple times is discouraged by RFC 5322 as this is an obsolete behavior only permitted by legacy implementations.

  • return: the header information of the mail.
  • since: API 1.9.0
  • access: public
array getMultipleHeaders ()
getPlainText (line 74)

Returns the plain text part of the mail, or null if the mail type is

Returns the plain text part of the mail, or null if the mail type is Inx_Api_Mail_MailContent::MAIL_TYPE_HTML_TEXT

  • return: the plain text part of the mail, if any.
  • access: public
string getPlainText ()
getRecipientAddress (line 88)

Returns the recipient address of the mail.

Returns the recipient address of the mail.

  • return: the recipient address of the mail.
  • access: public
string getRecipientAddress ()
getReplyToAddress (line 102)

Returns the reply address of the mail.

Returns the reply address of the mail. This address will be used for replies.

  • return: the reply address of the mail.
  • access: public
string getReplyToAddress ()
getSenderAddress (line 95)

Returns the sender address of the mail.

Returns the sender address of the mail.

  • return: the sender address of the mail.
  • access: public
string getSenderAddress ()
getSubject (line 81)

Returns the subject of the mail.

Returns the subject of the mail.

  • return: the subject of the mail.
  • access: public
string getSubject ()
Class Constants
MAIL_TYPE_HTML_TEXT = 0 (line 36)

Mail type indicating a HTML text mail.

Mail type indicating a HTML text mail. This mail has only a HTML text part.

MAIL_TYPE_MULTIPART = 2 (line 46)

Mail type indicating a multipart mail.

Mail type indicating a multipart mail. This mail has a HTML and a plain text part.

MAIL_TYPE_PLAIN_TEXT = 1 (line 41)

Mail type indicating a plain text mail.

Mail type indicating a plain text mail. This mail has only a plain text part.

Documentation generated on Thu, 17 Sep 2015 14:27:26 +0200 by phpDocumentor 1.3.2