An Inx_Api_TriggerMailing_TriggerMailing is a special kind of mailing introduced with Inxmail Professional 4.
An Inx_Api_TriggerMailing_TriggerMailing is a special kind of mailing introduced with Inxmail Professional 4.2. The difference between a normal mailing and a trigger mailing is the way they are sent. Normal mailings are sent on demand while trigger mailings are sent when the trigger they are bound to is fired. For example, a birthday trigger mailing is sent each day on which one ore more recipients birthday is. This feature can be combined with dynamic lists and target groups for full control over who receives which mailing.
Most trigger mailings are associated with a date or datetime attribute. The following trigger mailing types (see Inx_Api_TriggerMailing_Descriptor_TriggerType) are supported:
A TriggerMailing object can be used to perform various tasks:
For the most part, the content handling and approval process of trigger mailings is identical to that of normal mailings (see Inx_Api_Mailing_Mailing). There is only one difference regarding the approval process: instead of approving a mailing using the deprecated approval methods (especially approve()), a new method - approveImmediateley - was introduced to bypass the approval process. Given the API user has the necessary permissions, it can be used to approve a trigger mailing directly.
<strong>Controlling dispatch of trigger mailings</strong>
As mentioned earlier, trigger mailings cannot be simply sent to all recipients of the mailing list. Instead, you activate or deactivate the trigger of a trigger mailing, given the mailing is approved. The activation and deactivation of the trigger is as simple as calling the appropriate method:
<strong>Note:</strong> For existing trigger mailings, always call lock() before updating it, and unlock() after committing changes!
For an example on how to retrieve and create trigger mailings, see the Inx_Api_TriggerMailing_TriggerMailingManager documentation.
For more information on the creation of Inx_Api_Approval_Approvers, see the Inx_Api_Approval_ApproverManager documentation.
Located in /Api/TriggerMailing/TriggerMailing.php (line 81)
Inx_Api_BusinessObject | --Inx_Api_TriggerMailing_TriggerMailing
Activates the sending of this trigger mailing. activated, so the mailing is ready to be sent. during the next dispatch cycle.
Activates the sending of this trigger mailing. More correctly, the trigger of the trigger mailing will be activated, so the mailing is ready to be sent. Once the sending is activated, the trigger mailing can be sent during the next dispatch cycle.
Approves this trigger mailing for activation.
Approves this trigger mailing for activation. The trigger mailing may only be approved if it is in the following state:
Approves this trigger mailing immediately, bypassing the normal approval process if necessary. process can only be bypassed if the API user has the according right.
Approves this trigger mailing immediately, bypassing the normal approval process if necessary. The approval process can only be bypassed if the API user has the according right.
Deactivates the sending of this trigger mailing. deactivated, so the mailing can not be sent. active sendings.
Deactivates the sending of this trigger mailing. More correctly, the trigger of the trigger mailing will be deactivated, so the mailing can not be sent. The bool parameter is used to define the behaviour upon active sendings.
Denies the approval of this trigger mailing.
Denies the approval of this trigger mailing. The approval of the trigger mailing may only be denied if it is in the following state:
Returns the Inx_Api_Sending_Sending object for the last sending of this trigger mailing, if any.
Returns the Inx_Api_Sending_Sending object for the last sending of this trigger mailing, if any.
Returns an Inx_Api_ROBOResultSet containing all sendings of this trigger mailing.
Returns an Inx_Api_ROBOResultSet containing all sendings of this trigger 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 creation datetime of the trigger mailing.
Returns the creation datetime of the trigger mailing.
Returns the approval deadline datetime of this trigger mailing if the trigger mailing is in the state TriggerMailingState::APPROVAL_REQUESTED. may be returned.
Returns the approval deadline datetime of this trigger mailing if the trigger mailing is in the state TriggerMailingState::APPROVAL_REQUESTED. If the mailing state is not APPROVAL_REQUESTED, null may be returned.
Returns the approval escalation datetime of this trigger mailing if the trigger mailing is in the state TriggerMailingState::APPROVAL_REQUESTED and the approval process is escalating. state is not APPROVAL_REQUESTED or the approval process is identical, null may be returned.
Returns the approval escalation datetime of this trigger mailing if the trigger mailing is in the state TriggerMailingState::APPROVAL_REQUESTED and the approval process is escalating. If the mailing state is not APPROVAL_REQUESTED or the approval process is identical, null may be returned.
Returns the sending filters of this trigger mailing.
Returns the sending filters of this trigger mailing. For more information on Filters, see the Inx_Api_Filter_Filter documentation.
Returns the sending filter concatenation type of this trigger mailing.
Returns the sending filter concatenation type of this trigger mailing. May be one of the following:
Returns one of the sending filters (probably the first) of this trigger mailing.
Returns one of the sending filters (probably the first) of this trigger mailing. For more information on Filters, see the Inx_Api_Filter_Filte documentation.
Returns the id of the list context this trigger mailing belongs to.
Returns the id of the list context this trigger mailing belongs to.
Returns the lock ticket.
Returns the lock ticket. The lock ticket contains the following information:
Returns the state of this trigger mailing.
Returns the state of this trigger mailing. The state may be one of:
Returns the last modification datetime.
Returns the last modification datetime.
Returns the name of this trigger mailing.
Returns the name of this trigger mailing.
Returns the date of the next sending of this trigger mailing.
Returns the date of the next sending of this trigger mailing.
Returns the value of the X-Priority header.
Returns the value of the X-Priority header. Allowed values are:
Returns the reply address of this trigger mailing.
Returns the reply address of this trigger mailing.
Returns the sender address of this trigger mailing.
Returns the sender address of this trigger mailing.
Returns the subject of this trigger mailing.
Returns the subject of this trigger mailing.
Returns the trigger descriptor of this trigger mailing. and all settings regarding the trigger.
Returns the trigger descriptor of this trigger mailing. The trigger descriptor is used to define the mailing type and all settings regarding the trigger.
Returns the state of the trigger of this trigger mailing.
Returns the state of the trigger of this trigger mailing. The state may be one of:
Returns the type of this trigger mailing.
Returns the type of this trigger mailing. This is a shortcut for:
getTriggerDescriptor()->getType()
Returns a bool indicating whether this trigger mailing is active.
Returns a bool indicating whether this trigger mailing is active.
Checks if this trigger mailing is locked by a session, regardless of the lock owner.
Checks if this trigger mailing is locked by a session, regardless of the lock owner.
Locks this TriggerMailing, so it cannot be locked by another session.
Locks this TriggerMailing, so it cannot be locked by another session. <strong>Note:</strong> For existing trigger mailings, always call lock() before updating it, and unlock() after committing changes!
<strong>Updating existing trigger mailings without explicit locking is strongly discouraged.</strong>
Requests escalating approval for this trigger mailing. the escalation date expires without the first approver having approved the trigger mailing, the request is sent to the second approver. mailing, the request will be cancelled. the approval again.
Requests escalating approval for this trigger mailing. At first sends the request only to the first approver. If the escalation date expires without the first approver having approved the trigger mailing, the request is sent to the second approver. If the deadline date expires without any of the approvers having approved the trigger mailing, the request will be cancelled. In order to approve it, the trigger mailing creator will have to request the approval again. The approval of the trigger mailing may only be requested if it is in the following state:
Requests identical approval for this trigger mailing. requires both approvers to approve the trigger mailing. having approved the trigger mailing (and the other not reacted), the request will be cancelled. approve it, the trigger mailing creator will have to request the approval again.
Requests identical approval for this trigger mailing. Sends the request to both approvers simultaneously and requires both approvers to approve the trigger mailing. If the deadline date expires without one of the approvers having approved the trigger mailing (and the other not reacted), the request will be cancelled. In order to approve it, the trigger mailing creator will have to request the approval again. The approval of the trigger mailing may only be requested if it is in the following state:
Revokes the approval for this trigger mailing.
Revokes the approval for this trigger mailing. The approval of the trigger mailing may only be revoked if it is in one of the following states:
Sends this trigger mailing to the specified test address. email content, creating a preview of the trigger mailing.
Sends this trigger mailing to the specified test address. The specified recipient will be used to personalize the email content, creating a preview of the trigger mailing.
Sends this trigger mailing to the specified test address. the email content, creating a preview of the trigger mailing.
Sends this trigger mailing to the specified test address. The specified test profile will be used to personalize the email content, creating a preview of the trigger mailing.
Creates a new content handler.
Creates a new content handler. Allowed classes are:
Releases the lock of this TriggerMailing.
Releases the lock of this TriggerMailing.
Sets the given filter as the only sending filter of this trigger mailing.
Sets the given filter as the only sending filter of this trigger mailing. For more information on Filters, see the Inx_Api_Filter_Filter documentation.
Sets the filters used as the sending filters of this trigger mailing, concatenated using the given concatenation type.
Sets the filters used as the sending filters of this trigger mailing, concatenated using the given concatenation type. The possible types are:
Sets the name of this trigger mailing.
Sets the name of this trigger mailing.
Sets the value of the X-Priority header.
Sets the value of the X-Priority header. Allowed values are:
Sets the subject of this trigger mailing.
Sets the subject of this trigger mailing.
Updates the trigger descriptor of this trigger mailing.
Updates the trigger descriptor of this trigger mailing. Be aware that the trigger type can not be changed.
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:33 +0200 by phpDocumentor 1.3.2