Interface Inx_Api_MailingTemplate_MailingTemplate

Description

An Inx_Api_MailingTemplate_MailingTemplate represents reusable mailing content that can be used as a basis for new mailings.

An Inx_Api_MailingTemplate_MailingTemplate represents reusable mailing content that can be used as a basis for new mailings. These templates are far less powerful than the templates provided by design collections, but can still save time in the creation of complex mailings with a common structure. For an example on how to retrieve and create MailingTemplates, see the Inx_Api_MailingTemplate_MailingTemplateManager documentation.

Located in /Api/MailingTemplate/MailingTemplate.php (line 21)

Inx_Api_BusinessObject
   |
   --Inx_Api_MailingTemplate_MailingTemplate
Class Constant Summary
Method Summary
string getHtmlTextContent ()
int getMimeType ()
string getName ()
void updateHtmlTextContent (string $sHtmlTextContent)
void updateName (string $sName)
void updatePlainTextContent (string $sPlainTextContent)
Methods
getHtmlTextContent (line 105)

Returns the HTML text part of this mailing template, or null if the MIME type is MIME_TYPE_PLAIN_TEXT.

Returns the HTML text part of this mailing template, or null if the MIME type is MIME_TYPE_PLAIN_TEXT.

  • return: the HTML text part of this mailing template, if any.
  • access: public
string getHtmlTextContent ()
getListContextId (line 85)

Returns the id of the list which this mailing template belongs to.

Returns the id of the list which this mailing template belongs to.

  • return: the id of the list which this mailing template belongs to.
  • access: public
int getListContextId ()
getMimeType (line 97)

Returns the MIME type of this mailing template.

Returns the MIME type of this mailing template. May be one of:

  • MIME_TYPE_HTML_TEXT: Only HTML text
  • MIME_TYPE_PLAIN_TEXT: Only plain text
  • MIME_TYPE_MULTIPART: Both, HTML and plain text

  • return: the MIME type of this mailing template.
  • access: public
int getMimeType ()
getName (line 70)

Returns the name of the mailing template.

Returns the name of the mailing template.

  • return: the name of the mailing template.
  • access: public
string getName ()
getPlainTextContent (line 121)

Returns the plain text part of this mailing template, or

  1. null
if the MIME type is MIME_TYPE_HTML_TEXT.

Returns the plain text part of this mailing template, or

  1. null
if the MIME type is MIME_TYPE_HTML_TEXT.

  • return: the plain text part of this mailing template, if any.
  • access: public
string getPlainTextContent ()
updateHtmlTextContent (line 113)

Updates the HTML text part of this mailing template. commitUpdate() has been called.

Updates the HTML text part of this mailing template. The mailing template will not be updated on the server until commitUpdate() has been called.

  • access: public
void updateHtmlTextContent (string $sHtmlTextContent)
  • string $sHtmlTextContent: the new HTML text part.
updateName (line 78)

Updates the name of the mailing template.

Updates the name of the mailing template. The mailing template will not be updated on the server until commitUpdate() has been called.

  • access: public
void updateName (string $sName)
  • string $sName: the new template name.
updatePlainTextContent (line 129)

Updates the plain text part of the mailing template. commitUpdate() has been called.

Updates the plain text part of the mailing template. The mailing template will not be updated on the server until commitUpdate() has been called.

  • access: public
void updatePlainTextContent (string $sPlainTextContent)
  • string $sPlainTextContent: the new plain text part.

Inherited Methods

Inherited From Inx_Api_BusinessObject

Inx_Api_BusinessObject::commitUpdate()
Inx_Api_BusinessObject::getId()
Inx_Api_BusinessObject::reload()
Class Constants
ATTRIBUTE_HTML_TEXT = 2 (line 53)

Constant for the HTML text attribute.

Constant for the HTML text attribute.

ATTRIBUTE_LIST_CONTEXT_ID = 3 (line 58)

Constant for the list context id attribute.

Constant for the list context id attribute.

ATTRIBUTE_MIME_TYPE = 4 (line 63)

Constant for the MIME type attribute.

Constant for the MIME type attribute.

ATTRIBUTE_NAME = 0 (line 43)

Constant for the name attribute.

Constant for the name attribute. Used for ordering by the Inx_Api_MailingTemplate_MailingTemplateManager.

  • see: Inx_Api_MailingTemplate_MailingTemplateManager::select($oListContext, $iOrderAttribute, $iOrderType)
ATTRIBUTE_PLAIN_TEXT = 1 (line 48)

Constant for the plain text attribute.

Constant for the plain text attribute.

MIME_TYPE_HTML_TEXT = 0 (line 26)

MIME type constant for HTML text templates.

MIME type constant for HTML text templates. This template has only a HTML text part.

MIME_TYPE_MULTIPART = 2 (line 36)

MIME type constant for multipart templates.

MIME type constant for multipart templates. This template has a HTML and a plain text part.

MIME_TYPE_PLAIN_TEXT = 1 (line 31)

MIME type constant for plain text templates.

MIME type constant for plain text templates. This template has only a plain text part.

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