The Inx_Api_Mail_MailingRenderer is used to generate mail content using the API.
The Inx_Api_Mail_MailingRenderer is used to generate mail content using the API. The main use of the class will be to generate personalized previews of mailings. The class can also be used to generate and send single mails using a different mail sender. Be aware that in this case the mail sending rate would decrease enormously. To preview a mailing, acquire an Inx_Api_Mail_MailingRenderer from the Inx_Api_Mailing_MailingManager. Each mailing needs to be parsed before building it. The following snippet shows how to build a mail for a given recipient:
$oMailingRenderer = $oSession->getMailingManager()->createRenderer(); $oMailingRenderer->parse( $oMailing->getId(), Inx_Api_Mail_MailingRenderer::BUILD_MODE_ALTERNATIVEVIEW_ACTIVE ); $oMailContent = $oMailingRenderer->build( $iRecipientId );
Inx_Api_Mail_MailingRenderer can handle the following different build modes:
<strong>Note:</strong> An Inx_Api_Mail_MailingRenderer object <strong>must</strong> be closed once it is not needed anymore to prevent memory leaks and other potentially harmful side effects.
Located in /Api/Mail/MailingRenderer.php (line 50)
Generates the personalized mail content (recipient address, subject, HTML and/or plain text, . specified recipient with a specified mail type restriction.
Generates the personalized mail content (recipient address, subject, HTML and/or plain text, ...) for the specified recipient with a specified mail type restriction.
Closes this Inx_Api_Mail_MailingRenderer and releases any server resources associated with this object.
Closes this Inx_Api_Mail_MailingRenderer and releases any server resources associated with this object. An Inx_Api_Mail_MailingRenderer object <strong>must</strong> be closed once it is not needed anymore to prevent memory leaks and other potentially harmful side effects.
Prepares the mailing for a preview.
Prepares the mailing for a preview. It checks the mail integrity (syntax errors, references to orphaned elements, ... ).
Errors will be listed in the Inx_Api_Mail_ParseException.
The mailingId is supposed to be valid (existing mailing).
Mode for alternative view. image resources on the Inxmail server.
Mode for alternative view. All links are fully functional. Embedded images are replaced with http references to image resources on the Inxmail server.
Mode for alternative view. any event or generate any click. Inxmail server.
Mode for alternative view. Standard links are not functional, tracking links are functional but will not trigger any event or generate any click. Embedded images are replaced with http references to image resources on the Inxmail server.
Mode for archive view. any event or generate any click, unsubscription links will redirect but not unsubscribe anybody. are replaced with http references to image resources on the Inxmail server. return true while building the mailing.
Mode for archive view. Standard links are fully functional, tracking links are functional but will not trigger any event or generate any click, unsubscription links will redirect but not unsubscribe anybody. Embedded images are replaced with http references to image resources on the Inxmail server. The function InInboxView() will return true while building the mailing.
Mode to generate a normal mail, ready to be sent.
Mode to generate a normal mail, ready to be sent.
Mode for mail preview. any event or generate any click, unsubscription links will redirect but not unsubscribe anybody. are replaced with http references to image resources on the Inxmail server. return true while building the mailing.
Mode for mail preview. Standard links are fully functional, tracking links are functional but will not trigger any event or generate any click, unsubscription links will redirect but not unsubscribe anybody. Embedded images are replaced with http references to image resources on the Inxmail server. The function InInboxView() will return true while building the mailing.
Documentation generated on Thu, 17 Sep 2015 14:27:27 +0200 by phpDocumentor 1.3.2