An Inx_Api_Mailing_Mailing object represents a mailing in inxmail.
An Inx_Api_Mailing_Mailing object represents a mailing in inxmail. An Inx_Api_Mailing_Mailing object can be used to perform various tasks:
All of these handlers offer methods to edit the content of the mailing. The following snippet changes the content of a plain text mailing:
$oMailing->setContentHandler( 'Inx_Api_Mailing_PlainTextContentHandler' ); $oContentHandler = $oMailing->getContentHandler(); $oContentHandler->updateContent( "...any mailing content..." ); $oMailing->commitUpdate();<strong>Approval and controlling dispatch</strong>
The following methods can be used for the approval of mailings:
Note: The methods for approving a mailing are functional since Inxmail 3.8.1.
The Following methods can be used to send mailings:
To schedule a mailing instead of sending it immediately, use the scheduleMailing($sScheduleTime) method. The following snippet shows how to schedule a mailing to be sent in one hour:
$oMailing->scheduleMailing( date( 'c', strtotime("+1 hour") ) );
The following snippet shows how to revoke the scheduled sending of a mailing:
mailing->unscheduleMailing();
<strong>Note:</strong> For existing mailings, always call
For an example on how to retrieve and create mailings, see the Inx_Api_Mailing_MailingManager documentation.
For more information on the creation of Inx_Api_Approval_Approvers, see the Inx_Api_Approval_ApproverManager documentation.
Located in /Api/Mailing/Mailing.php (line 105)
Inx_Api_BusinessObject | --Inx_Api_Mailing_Mailing
FILTER_AND
getFilterConcatinationType
()
Approve this mailing for sending.
Approve this mailing for sending. Allowed mailing states are:
Deny approval of this mailing.
Deny approval of this mailing. Allowed mailing states are:
Returns the Inx_Api_Sending_Sending object for the last sending of this mailing, if any.
Returns the Inx_Api_Sending_Sending object for the last sending of this mailing, if any.
Returns an Inx_Api_ROBOResultSet containing all sendings of this mailing.
Returns an Inx_Api_ROBOResultSet containing all sendings of this mailing.
Returns the content handler, which contains the format-specific mail content.
Returns the content handler, which contains the format-specific mail content.
Returns the create date of the mailing
Returns the create date of the mailing
Returns the approval deadline datetime of this mailing if the mailing is in the state STATE_TO_BE_APPROVE.
Returns the approval deadline datetime of this mailing if the mailing is in the state STATE_TO_BE_APPROVE. If the mailing state is not STATE_TO_BE_APPROVE, null may be returned. The date will be returned as ISO 8601 formatted datetime string.
Returns the approval escalation datetime of this mailing if the mailing is in the state STATE_TO_BE_APPROVE and the approval process is escalating.
Returns the approval escalation datetime of this mailing if the mailing is in the state STATE_TO_BE_APPROVE and the approval process is escalating. If the mailing state is not STATE_TO_BE_APPROVE or the approval process is identical, null may be returned. The date will be returned as ISO 8601 formatted datetime string.
Returns the sending filter concatenation type of this mailing.
Returns the sending filter concatenation type of this mailing.
FILTER_AND
getFilterConcatinationType
()
Returns a sending filter of this mailing.
Returns a sending filter of this mailing.
Returns the sending filter of this mailing.
Returns the sending filter of this mailing.
Returns the id of list context which this mailing belongs to.
Returns the id of list context which this mailing belongs to.
Returns the lock ticket.
Returns the lock ticket.
Returns the last modification datetime.
Returns the last modification datetime.
Returns the name of this mailing.
Returns the name of this mailing.
Returns the value of X-Priority header.
Returns the value of X-Priority header. Allowed values are:
Returns the recipient address of this mailing.
Returns the recipient address of this mailing.
Returns the recipient address of this mailing.
Returns the recipient address of this mailing.
Returns the schedule datetime.
Returns the schedule datetime.
Returns the sender address of this mailing.
Returns the sender address of this mailing.
Returns the mailing info object which contains the number sent mails.
Returns the mailing info object which contains the number sent mails.
Returns the sent datetime, null if this mailing not yet sent.
Returns the sent datetime, null if this mailing not yet sent.
Returns the mailing state.
Returns the mailing state.
Returns the subject of this mailing.
Returns the subject of this mailing.
Checks if this mailing has a lock.
Checks if this mailing has a lock.
Lock the this Inx_Api_Mailing_Mailing.
Lock the this Inx_Api_Mailing_Mailing. For existing mailings, always call lock() before updating it, and unlock() after committing changes!
Request the approval for this mailing.
Request the approval for this mailing. Allowed mailing states are:
Request the escalating approval for this mailing.
Request the escalating approval for this mailing. Allowed mailing states are:
Request the escalating approval for this mailing.
Request the escalating approval for this mailing. Allowed mailing states are:
Revoke the approval or scheduling for this mailing.
Revoke the approval or scheduling for this mailing. Allowed mailing states are:
Schedules the mailing with the given date.
Schedules the mailing with the given date. Allowed mailing states are:
Sending this mailing to the specified recipient. to generating the email content.
Sending this mailing to the specified recipient. Using the recipient to generating the email content.
Sending this mailing to the test address. to generating the email content.
Sending this mailing to the test address. Using the specified recipient to generating the email content.
Sending this mailing to the test address. to generating the email content.
Sending this mailing to the test address. Using the specified recipient to generating the email content.
Creates a new content handler.
Creates a new content handler. Allowed classes are:
Start or restart the sending of this mailing.
Start or restart the sending of this mailing. Allowed mailing states are:
Stop the sending of the specified mailing.
Stop the sending of the specified mailing. Allowed mailing states are:
Release the lock of this Inx_Api_Mailing_Mailing.
Release the lock of this Inx_Api_Mailing_Mailing.
Unschedules the mailing.
Unschedules the mailing. Allowed mailing states are:
Sets a sending filter of this mailing.
Sets a sending filter of this mailing.
Sets a couple of sending filter to this mailing.
Sets a couple of sending filter to this mailing.
Sets the name of this mailing.
Sets the name of this mailing.
Sets the value of X-Priority header.
Sets the value of X-Priority header. Allowed values are:
Sets the recipient address of this mailing.
Sets the recipient address of this mailing.
Sets the replyTo address of this mailing.
Sets the replyTo address of this mailing.
Sets the schedule datetime.
Sets the schedule datetime.
Sets the sender address of this mailing.
Sets the sender address of this mailing.
Sets the subject of this mailing.
Sets the subject of this mailing.
Inherited From Inx_Api_BusinessObject
Inx_Api_BusinessObject::commitUpdate()
Inx_Api_BusinessObject::getId()
Inx_Api_BusinessObject::reload()
Documentation generated on Thu, 17 Sep 2015 14:27:26 +0200 by phpDocumentor 1.3.2