Interface Inx_Api_Util_TemporaryMail

Description

A Inx_Api_Util_TemporaryMail is a mailing that may be sent to a single recipient that does not have to be a registered recipient in Inxmail.

A Inx_Api_Util_TemporaryMail is a mailing that may be sent to a single recipient that does not have to be a registered recipient in Inxmail. A temporary mailing behaves mostly like a simple version of a normal Inx_Api_Mailing_Mailing. However, the mailing will not be personalized and will not be saved in Inxmail and therefore won't be trackable. TemporaryMails may be sent using the Inx_Api_Util_TemporaryMailSender. Because a TemporaryMail does not belong to a specific list, you have to specify some information not needed when using a normal Mailing. The most important is the recipient address. Normally, the recipient address is determined by the list, but as a temporary mail does not belong to any list, there is no predefined recipient address. The same is true for the reply address, though this address is not technically required to send the mail. The sender address, on the other hand, does not have to be specified as long as it is configured in the list that was passed on the creation of the temporary mailing.

<strong>Note:</strong> While it is discouraged to explicitly set the recipient address of a standard Inx_Api_Mailing_Mailing, this is a technical requirement for the TemporaryMail. You won't be able to send a temporary mail to a recipient not registered in Inxmail without specifying the sender address, though the send method will return true. You may, however, send the mailing to a recipient known by Inxmail, without explicitly specifying the sender address. To do so, use the Inx_Api_Util_TemporaryMailSender::sendTemporaryMail($oTemporaryMail, $iRecipientId) method. This method will also personalize the mailing for the given recipient.

For an example on how to send a temporary mail, see the Inx_Api_Util_TemporaryMailSender documentation.

Located in /Api/Util/TemporaryMail.php (line 38)


	
			
Method Summary
string getReplyToAddress ()
string getSenderAddress ()
string getSubject ()
void setContentHandler (string $oContentHandlerClazz)
void updateRecipientAddress (string $sRecipientAddress)
void updateReplyToAddress (string $sReplyToAddress)
void updateSenderAddress (string $sSenderAddress)
void updateSubject (string $sSubject)
Methods
getContentHandler (line 108)

Returns the content handler, which contains the format-specific mail content.

Returns the content handler, which contains the format-specific mail content.

  • return: the content handler.
  • access: public
Inx_Api_Mailing_ContentHandler getContentHandler ()
getRecipientAddress (line 61)

Returns the recipient address header value of this temporary mailing.

Returns the recipient address header value of this temporary mailing. This is the address to which the mailing will be sent.

  • return: the recipient address header value of this temporary mailing.
  • access: public
string getRecipientAddress ()
getReplyToAddress (line 77)

Returns the reply address of this temporary mailing.

Returns the reply address of this temporary mailing.

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

Returns the sender address of this temporary mailing.

Returns the sender address of this temporary mailing.

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

Returns the subject of this temporary mailing.

Returns the subject of this temporary mailing.

  • return: the subject of this temporary mailing.
  • access: public
string getSubject ()
setContentHandler (line 123)

Creates a new content handler.

Creates a new content handler. Allowed classes are:

  • PlainTextContentHandler
  • HtmlTextContentHandler
  • MultiPartContentHandler
  • XsltMultiPartContentHandler
  • XsltHtmlTextContentHandler
  • XsltPlainTextContentHandler

  • access: public
void setContentHandler (string $oContentHandlerClazz)
  • string $oContentHandlerClazz: the Class of the content handler
updateRecipientAddress (line 69)

Sets the recipient address header value of this temporary mailing.

Sets the recipient address header value of this temporary mailing. This is the address to which the mailing will be sent.

  • access: public
void updateRecipientAddress (string $sRecipientAddress)
  • string $sRecipientAddress: the recipient address header value of this temporary mailing.
updateReplyToAddress (line 85)

Sets the reply address of this temporary mailing.

Sets the reply address of this temporary mailing. Replies to this mailing will be sent to the given address.

  • access: public
void updateReplyToAddress (string $sReplyToAddress)
  • string $sReplyToAddress: the reply address of this mailing.
updateSenderAddress (line 52)

Sets the sender address of this temporary mailing.

Sets the sender address of this temporary mailing.

  • access: public
void updateSenderAddress (string $sSenderAddress)
  • string $sSenderAddress: the sender address of this temporary mailing.
updateSubject (line 100)

Sets the subject of this temporary mailing.

Sets the subject of this temporary mailing.

  • access: public
void updateSubject (string $sSubject)
  • string $sSubject: the subject of this temporary mailing.

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