Interface Inx_Api_Rendering_Content

Description

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

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

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

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

  • see: Inx_Api_Rendering_GeneralMailingRenderer::build($iRecipientId, $preferredMailType)
  • since: API 1.11.10

Located in /Api/Rendering/Content.php (line 30)


	
			
Method Summary
Methods
getAttachments (line 96)

Returns all regular attachments (files) of the mailing, or an empty array if there is no attachment.

Returns all regular attachments (files) of the mailing, or an empty array if there is no attachment.

  • return: of Inx_Api_Rendering_Attachment all regular attachments of the mailing, or an empty array.
  • access: public
array() getAttachments ()
getBounceAddress (line 89)

Returns the bounce address of the mailing.

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

  • return: the bounce address of the mailing.
  • access: public
string getBounceAddress ()
getContentType (line 38)

Returns the content type of the mailing.

Returns the content type of the mailing.

  • return: the content type of the mailing.
  • access: public
Inx_Api_Rendering_ContentType getContentType ()
getEmbeddedImages (line 103)

Returns all embedded images of the mailing, or an empty array if there is no attachment.

Returns all embedded images of the mailing, or an empty array if there is no attachment.

  • return: of Inx_Api_Rendering_Attachment all embedded images of the mailing, or an empty array.
  • access: public
array() getEmbeddedImages ()
getHeader (line 117)

Returns the header informations of the mailing. contain any null value, neither as key, nor as value.

Returns the header informations of the mailing. The map contains the key/value-pair of the headers and does not contain any null value, neither as key, nor as value. If there is no header, an empty map is returned. 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 Inx_Api_Rendering_Content::getMultipleHeaders() method instead. Nonetheless, 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: of string => string the header information of the mailing.
  • access: public
array() getHeader ()
getHtmlText (line 46)

Returns the HTML text part of the mailing, or null if the Inx_Api_Rendering_ContentType is Inx_Api_Rendering_ContentType::PLAIN_TEXT.

Returns the HTML text part of the mailing, or null if the Inx_Api_Rendering_ContentType is Inx_Api_Rendering_ContentType::PLAIN_TEXT.

  • return: the HTML text part of the mailing, if any.
  • access: public
string getHtmlText ()
getMultipleHeaders (line 129)

Returns the header information of the mailing. encapsulating the key/value-pairs of the headers. field.

Returns the header information of the mailing. The list contains Inx_Api_Rendering_HeaderField objects encapsulating the key/value-pairs of the headers. This method allows multiple definitions of the same header field. If there is no header, an empty list is returned. 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: of Inx_Api_Rendering_HeaderField the header information of the mailing.
  • access: public
array() getMultipleHeaders ()
getPlainText (line 54)

Returns the plain text part of the mailing, or null if the Inx_Api_Rendering_ContentType is Inx_Api_Rendering_ContentType::HTML_TEXT.

Returns the plain text part of the mailing, or null if the Inx_Api_Rendering_ContentType is Inx_Api_Rendering_ContentType::HTML_TEXT.

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

Returns the recipient address of the mailing.

Returns the recipient address of the mailing.

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

Returns the reply address of the mailing.

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

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

Returns the sender address of the mailing.

Returns the sender address of the mailing.

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

Returns the subject of the mailing, if any.

Returns the subject of the mailing, if any.

  • return: the subject of the mailing, if any.
  • access: public
string getSubject ()

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