Interface Inx_Api_TriggerMail_TriggerMailContent

Description

The

  1. TriggerMailContent
contains the personalized content of a trigger mailing for a specific recipient.

The

  1. TriggerMailContent
contains the personalized content of a trigger mailing for a specific recipient. The information that can be retrieved from the
  1. TriggerMailContent
includes:
  • The content type: #getContentType()
  • 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()
A
  1. TriggerMailContent
object is created by a TriggerMailingRenderer using its
  1. build
methods.

  • author: chge, 09.07.2012
  • see: build(int)
  • see: build(int, int)
  • deprecated: As of 1.11.10, Inx_Api_TriggerMail_TriggerMailingRenderer has been replaced with Inx_Api_Rendering_GeneralMailingRenderer
  • since: API 1.10.0

Located in /Api/TriggerMail/TriggerMailContent.php (line 31)


	
			
Method Summary
Methods
getAttachments (line 97)

Returns all regular attachments (files) of the trigger mail.

Returns all regular attachments (files) of the trigger mail.

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

Returns the bounce address of the trigger mail.

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

  • return: bounce address of the trigger mail.
  • access: public
the getBounceAddress ()
getContentType (line 39)

Returns the content type of this trigger mail.

Returns the content type of this trigger mail.

  • return: content type of this trigger mail.
  • access: public
the getContentType ()
getEmbeddedImages (line 104)

Returns all embedded images of the trigger mail.

Returns all embedded images of the trigger mail.

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

Returns the header informations of the trigger mail.

Returns the header informations of the trigger mail. The map 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 #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: header information of the trigger mail.
  • access: public
the getHeader ()
getHtmlText (line 47)

Returns the HTML text part of the mail, or

  1. null
if the mail type is PLAIN_TEXT.

Returns the HTML text part of the mail, or

  1. null
if the mail type is PLAIN_TEXT.

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

Returns the header information of the trigger mail. encapsulating the key/value-pairs of the headers.

Returns the header information of the trigger mail. The list contains

  1. 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: header information of the trigger mail.
  • since: API 1.9.0
  • access: public
the getMultipleHeaders ()
getPlainText (line 55)

Returns the plain text part of the mail, or

  1. null
if the mail type is HTML_TEXT.

Returns the plain text part of the mail, or

  1. null
if the mail type is HTML_TEXT.

  • return: plain text part of the email, if any.
  • access: public
the getPlainText ()
getRecipientAddress (line 69)

Returns the recipient address of the trigger mail.

Returns the recipient address of the trigger mail.

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

Returns the reply address of the trigger mail.

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

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

Returns the sender address of the trigger mail.

Returns the sender address of the trigger mail.

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

Returns the subject of the trigger mail.

Returns the subject of the trigger mail.

  • return: subject of the trigger mail.
  • access: public
the getSubject ()

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