Interface Inx_Api_TriggerMailing_TriggerMailing

Description

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:

  • TIME_TRIGGER_BIRTHDAY_MAILING: A mailing of this type is sent to recipients on the annual recurrence of a specific date. A datetime attribute of the recipient acts as a baseline and the mailing is sent every year after this baseline. An offset can be specified to send the mailing some time before or after the annual recurrence. The condition is checked once a day. The birthday trigger is an attribute driven time trigger.
  • TIME_TRIGGER_ANNIVERSARY_MAILING: A mailing of this type is sent to recipients on the recurrence of a specific date. A datetime attribute of the recipient acts as baseline and the mailing is sent after a user defined period of time (years, months or days) after this baseline. An offset can be specified to send the mailing some time before or after the recurrence. The condition is checked once a day. The anniversary trigger is an attribute driven time trigger.
  • TIME_TRIGGER_REMINDER_MAILING: A mailing of this type is sent to recipients on a specific date. A datetime attribute of the recipient defines that date. An offset can be specified to send the mailing some time before the date. The condition is checked once a day. The reminder trigger is an attribute driven time trigger.
  • TIME_TRIGGER_FOLLOW_UP_MAILING: A mailing of this type is sent to recipients on a specific date. A datetime attribute of the recipient defines that date. An offset can be specified to send the mailing some time after the date. The condition is checked once a day. The follow up trigger is an attribute driven time trigger.
  • TIME_TRIGGER_INTERVAL_MAILING: A mailing of this type is sent to all recipients of the associated list at a freely definable interval (i.e. hourly, daily, weekly,...). The interval is described by a TriggerInterval object. The interval trigger is a time trigger which is not related to a specific attribute.
  • ACTION_MAILING ACTION_MAILING: This mailing type is triggered by an action.

A TriggerMailing object can be used to perform various tasks:

  • Retrieve and update trigger mailing meta information and content
  • Activate or deactivate the sending of the trigger mailing
  • Request the approval of a trigger mailing
  • Approve or revoke the approval for the trigger mailing
<strong>Handling trigger mailing content and approval</strong>

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:

  • activateSending(): Activates the trigger of the trigger mailing.
  • deactivateSending($blStopActiveSending): Deactivates the trigger of the trigger mailing with the option to stop an active sending.

<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
Method Summary
void activateSending ()
void approve (int $iApproverId, string $sComment)
void approveImmediately (string $sComment)
void deactivateSending (bool $blStopActiveSending)
void denyApprove (int $iApproverId, string $sComment)
array getFilderIds ()
int getFilterId ()
string getName ()
string getNextSending ()
int getPriority ()
string getReplyToAddress ()
string getSenderAddress ()
string getSubject ()
bool isActive ()
bool isLocked ()
void lock ()
void requestEscalationApproval (string $sEscalationDate, string $sDeadline,  $approverIds,  $recipientIds, bool $blIsTestRecipient, string $sLocale)
void requestIdenticalApproval (string $sDeadline,  $approverIds,  $recipientIds, bool $blIsTestRecipient, string $sLocale)
void revokeApproval ([string $sComment = null])
void sendTestMail (string $sTestAddress, int $iRecipientId)
void sendTestMailWithTestprofile (string $sTestAddress, int $iTestprofileId)
void setContentHandler (string $sContentHandlerClazz)
true unlock ([bool $blForceForeignLock = false])
void updateFilterId (int $iFilterId)
void updateFilterIds ( $filterIds, Inx_Api_TriggerMailing_FilterConcatenationType $oConcatinationType)
void updateName (string $sName)
void updatePriority (int $iPriority)
void updateSubject (string $sSubject)
Methods
activateSending (line 117)

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.

  • throws: Inx_Api_DataException if this trigger mailing can not be found on the server.
  • throws: Inx_Api_TriggerMailing_TriggerMailingStateException if this trigger mailing is in an illegal state.
  • access: public
void activateSending ()
approve (line 166)

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:

  • TriggerMailingState::APPROVAL_REQUESTED ( -> APPROVED )
If the trigger mailing is in a state not listed here, a TriggerMailingStateException will be raised.

  • see: Inx_Api_Approval_ApproverManager
  • see: self::requestEscalationApproval( $sEscalationDate, $sDeadline, array $approverIds, array $recipientIds, $blIsTestRecipient, $sLocale )
  • see: self::requestIdenticalApproval( $sDeadline, array $approverIds, array $recipientIds, $blIsTestRecipient, $sLocale );
  • throws: Inx_Api_DataException if this trigger mailing can not be found on the server.
  • throws: Inx_Api_TriggerMailing_TriggerMailingStateException if this trigger mailing is in an illegal state.
  • throws: Inx_Api_UpdateException if the request cannot be completed, for example because the approval process is not activated for the list or trigger mailing.
  • access: public
void approve (int $iApproverId, string $sComment)
  • int $iApproverId: the id of the approver.
  • string $sComment: the comment of the approver.
approveImmediately (line 142)

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.

  • throws: Inx_Api_TriggerMailing_TriggerMailingStateException if the this trigger mailing is in an illegal state.
  • throws: Inx_Api_DataException if this trigger mailing cannot be found on the server.
  • throws: Inx_Api_UpdateException if the request cannot be completed.
  • access: public
void approveImmediately (string $sComment)
  • string $sComment: the comment for this approval.
deactivateSending (line 130)

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.

  • throws: Inx_Api_DataException if this trigger mailing can not be found on the server.
  • throws: Inx_Api_TriggerMailing_TriggerMailingStateException if this trigger mailing is in an illegal state.
  • access: public
void deactivateSending (bool $blStopActiveSending)
  • bool $blStopActiveSending: true if an active sending shall be interrupted, false if the sending may be finished first.
denyApprove (line 190)

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:

  • TriggerMailingState::APPROVAL_REQUESTED ( -> DRAFT )
If the trigger mailing is in another state, a TriggerMailingStateException will be raised.

  • see: Inx_Api_Approval_ApproverManager
  • see: self::requestEscalationApproval( $sEscalationDate, $sDeadline, array $approverIds, array $recipientIds, $blIsTestRecipient, $sLocale )
  • see: self::requestIdenticalApproval( $sDeadline, array $approverIds, array $recipientIds, $blIsTestRecipient, $sLocale );
  • throws: Inx_Api_DataException if this trigger mailing can not be found on the server.
  • throws: Inx_Api_TriggerMailing_TriggerMailingStateException if this trigger mailing is in an illegal state.
  • throws: Inx_Api_UpdateException if the request cannot be completed, for example because the approval process is not activated for the list or trigger mailing.
  • access: public
void denyApprove (int $iApproverId, string $sComment)
  • int $iApproverId: id of the approver
  • string $sComment: the comment of the approver.
findLastSending (line 641)

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.

  • return: The Sending object for the last sending of this trigger mailing, if any, null otherwise.
  • since: API 1.11.1
  • access: public
Inx_Api_Sending_Sending findLastSending ()
findSendings (line 631)

Returns an Inx_Api_ROBOResultSet containing all sendings of this trigger mailing.

Returns an Inx_Api_ROBOResultSet containing all sendings of this trigger mailing.

  • return: A ROBOResultSet containing all sendings of this trigger mailing.
  • since: API 1.11.1
  • access: public
Inx_Api_ROBOResultSet findSendings ()
getContentHandler (line 559)

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 ()
getCreationDatetime (line 583)

Returns the creation datetime of the trigger mailing.

Returns the creation datetime of the trigger mailing.

  • return: the creation datetime. The date is returned as ISO-8601 formatted datetime string.
  • access: public
string getCreationDatetime ()
getDeadlineDatetime (line 395)

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.

  • return: the approval deadline datetime, or null. The date is returned as ISO-8601 formatted datetime string.
  • see: self::requestIdenticalApproval( $sDeadline, array $approverIds, array $recipientIds, $blIsTestRecipient, $sLocale );
  • see: self::requestEscalationApproval( $sEscalationDate, $sDeadline, array $approverIds, array $recipientIds, $blIsTestRecipient, $sLocale )
  • access: public
string getDeadlineDatetime ()
getEscalationDatetime (line 380)

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.

  • return: the approval escalation datetime, or null. The date is returned as ISO-8601 formatted datetime string.
  • see: self::requestEscalationApproval( $sEscalationDate, $sDeadline, array $approverIds, array $recipientIds, $blIsTestRecipient, $sLocale )
  • access: public
string getEscalationDatetime ()
getFilderIds (line 452)

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.

array getFilderIds ()
getFilterConcatinationType (line 467)

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:

  • FilterConcatenationType::AND(),
  • FilterConcatenationType::OR() or
  • FilterConcatenationType::NOT_IN()

  • return: the filter concatenation type, or null if none is set.
  • access: public
Inx_Api_TriggerMailing_FilterConcatenationType getFilterConcatinationType ()
getFilterId (line 430)

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.

  • return: one of the filter ids, 0 means that no filters are set.
  • see: Inx_Api_Filter_Filter
  • access: public
int getFilterId ()
getListContextId (line 403)

Returns the id of the list context this trigger mailing belongs to.

Returns the id of the list context this trigger mailing belongs to.

  • return: the id of the list context this trigger mailing belongs to.
  • access: public
int getListContextId ()
getLockTicket (line 359)

Returns the lock ticket.

Returns the lock ticket. The lock ticket contains the following information:

  • Who locked the trigger mailing? - User id, name and IP address.
  • When was the lock created?
  • Did I create the lock?

  • return: the lock ticket.
  • access: public
Inx_Api_LockTicket getLockTicket ()
getMailingState (line 314)

Returns the state of this trigger mailing.

Returns the state of this trigger mailing. The state may be one of:

  • TriggerMailingState::DRAFT(): The default state of a new trigger mailing.
  • TriggerMailingState::APPROVAL_REQUESTED(): Approval has been requested for this trigger mailing.
  • TriggerMailingState::APPROVED(): The trigger mailing has been approved.
  • TriggerMailingState::USED(): The trigger mailing was activated at least once.
  • TriggerMailingState::UNKNOWN(): The trigger mailing state is unknown. This indicates a version mismatch between API and server.

  • return: the state of this trigger mailing.
  • access: public
getModificationDatetime (line 367)

Returns the last modification datetime.

Returns the last modification datetime.

  • return: the last modification datetime. The date is returned as ISO-8601 formatted datetime string.
  • access: public
string getModificationDatetime ()
getName (line 543)

Returns the name of this trigger mailing.

Returns the name of this trigger mailing.

  • return: the name of this trigger mailing.
  • access: public
string getName ()
getNextSending (line 622)

Returns the date of the next sending of this trigger mailing.

Returns the date of the next sending of this trigger mailing.

  • return: the date of the next sending of this trigger mailing. The date is returned as ISO-8601 formatted datetime string.
  • access: public
string getNextSending ()
getPriority (line 503)

Returns the value of the X-Priority header.

Returns the value of the X-Priority header. Allowed values are:

  • null - not specified, the X-Priority header will not be set
  • 5 - lowest priority
  • 4 - low priority
  • 3 - normal priority
  • 2 - high priority
  • 1 - highest priority

  • return: the value of the X-Priority header, or null if the priority is not set.
  • access: public
int getPriority ()
getReplyToAddress (line 419)

Returns the reply address of this trigger mailing.

Returns the reply address of this trigger mailing.

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

Returns the sender address of this trigger mailing.

Returns the sender address of this trigger mailing.

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

Returns the subject of this trigger mailing.

Returns the subject of this trigger mailing.

  • return: the subject of this trigger mailing.
  • access: public
string getSubject ()
getTriggerDescriptor (line 592)

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.

  • return: the trigger descriptor of this trigger mailing.
  • access: public
getTriggerState (line 330)

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:

  • TriggerState::INACTIVE(): The default state of a new time trigger mailing.
  • TriggerState::ACTIVE(): The trigger of this trigger mailing is active.
  • TriggerState::UNSPECIFIED(): This state is used when the trigger state can not be determined. This is the case for action trigger mailings.
  • TriggerState::UNKNOWN(): The trigger state is unknown. This indicates a version mismatch between API and server.

  • return: the state of the trigger of this trigger mailing.
  • access: public
getTriggerType (line 613)

Returns the type of this trigger mailing.

Returns the type of this trigger mailing. This is a shortcut for:

 getTriggerDescriptor()->getType()

  • return: the type of this trigger mailing.
  • access: public
isActive (line 338)

Returns a bool indicating whether this trigger mailing is active.

Returns a bool indicating whether this trigger mailing is active.

  • return: true if this trigger mailing is active, false otherwise.
  • access: public
bool isActive ()
isLocked (line 346)

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.

  • return: true if this trigger mailing is locked, false otherwise.
  • access: public
bool isLocked ()
lock (line 287)

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>

  • throws: Inx_Api_LockException if this trigger mailing is already locked by another session.
  • throws: Inx_Api_TriggerMailing_TriggerMailingStateException if this trigger mailing is in an illegal state.
  • throws: Inx_Api_DataException if this trigger mailing can not be found on the server.
  • access: public
void lock ()
requestEscalationApproval (line 222)

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:

  • TriggerMailingState::DRAFT ( -> APPROVAL_REQUESTED )
If the trigger mailing is in another state, a TriggerMailingStateException will be raised.

  • throws: Inx_Api_TriggerMailing_TriggerMailingStateException if this trigger mailing is in an illegal state.
  • throws: Inx_Api_DataException if this trigger mailing can not be found on the server.
  • throws: Inx_Api_UpdateException if the request cannot be completed, for example because the approval process is not activated for the list or trigger mailing.
  • access: public
void requestEscalationApproval (string $sEscalationDate, string $sDeadline,  $approverIds,  $recipientIds, bool $blIsTestRecipient, string $sLocale)
  • string $sEscalationDate: the escalation date. If this datetime expires, the second approver will get involved. The date has to be specified as ISO-8601 formatted datetime string.
  • string $sDeadline: the deadline. If this datetime expires, the request will be cancelled. The date has to be specified as ISO-8601 formatted datetime string.
  • array $approverIds: the ids of the two approvers involved in the approval process. You must specify exactly two approvers.
  • array $recipientIds: the ids of the recipients used to generate a personalized preview of the mailing. You must specify at least one recipient.
  • bool $blIsTestRecipient: true if the recipientId array contains test recipients (test profiles), false if it contains regular recipients.
  • string $sLocale: the user local that will be used to localize the request message and approval page.
requestIdenticalApproval (line 252)

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:

  • TriggerMailingState::DRAFT ( -> APPROVAL_REQUESTED )
If the trigger mailing is in another state, a TriggerMailingStateException will be raised.

  • throws: Inx_Api_TriggerMailing_TriggerMailingStateException if this trigger mailing is in an illegal state.
  • throws: Inx_Api_DataException if this trigger mailing can not be found on the server.
  • throws: Inx_Api_UpdateException if the request cannot be completed, for example because the approval process is not activated for the list or trigger mailing.
  • access: public
void requestIdenticalApproval (string $sDeadline,  $approverIds,  $recipientIds, bool $blIsTestRecipient, string $sLocale)
  • string $sDeadline: the deadline. If this datetime expires, the request will be cancelled if none of the approvers has approved the mailing.
  • array $approverIds: the ids of the two approvers involved in the approval process. You must specify exactly two approvers.
  • array $recipientIds: the ids of the recipients used to generate a personalized preview of the mailing. You must specify at least one recipient.
  • bool $blIsTestRecipient: true if the recipientId array contains test recipients (test profiles), false if it contains regular recipients.
  • string $sLocale: the user local that will be used to localize the request message and approval page.
revokeApproval (line 272)

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:

  • TriggerMailingState::APPROVED ( -> DRAFT )
  • TriggerMailingState::APPROVAL_REQUESTED ( -> DRAFT )
If the trigger mailing is in another state, a TriggerMailingStateException will be raised.

  • throws: Inx_Api_TriggerMailing_TriggerMailingStateException if this trigger mailing is in an illegal state.
  • throws: Inx_Api_DataException if this trigger mailing can not be found on the server.
  • throws: Inx_Api_UpdateException if the request cannot be completed, for example because the approval process is not activated for the list or trigger mailing.
  • access: public
void revokeApproval ([string $sComment = null])
  • string $sComment: the reason why the approval request was revoked. May be omitted.
sendTestMail (line 93)

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.

  • throws: Inx_Api_TriggerMailing_SendException if the trigger mailing could not be sent.
  • throws: Inx_Api_TriggerMailing_TriggerMailingStateException if this trigger mailing is in an illegal state.
  • throws: Inx_Api_DataException if this trigger mailing can not be found on the server.
  • access: public
void sendTestMail (string $sTestAddress, int $iRecipientId)
  • string $sTestAddress: the email address to which the trigger mailing shall be sent.
  • int $iRecipientId: the recipient to personalize the email content for.
sendTestMailWithTestprofile (line 106)

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.

  • throws: Inx_Api_TriggerMailing_SendException if the trigger mailing could not be sent.
  • throws: Inx_Api_TriggerMailing_TriggerMailingStateException if this trigger mailing is in an illegal state.
  • throws: Inx_Api_DataException if this trigger mailing can not be found on the server.
  • access: public
void sendTestMailWithTestprofile (string $sTestAddress, int $iTestprofileId)
  • string $sTestAddress: the email address to which the trigger mailing shall be sent.
  • int $iTestprofileId: the test profile to personalize the email content for.
setContentHandler (line 575)

Creates a new content handler.

Creates a new content handler. Allowed classes are:

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

  • access: public
void setContentHandler (string $sContentHandlerClazz)
  • string $sContentHandlerClazz: the class name of the content handler.
unlock (line 298)

Releases the lock of this TriggerMailing.

Releases the lock of this TriggerMailing.

  • return: if this trigger mailing was unlocked, false otherwise.
  • throws: Inx_Api_DataException if this trigger mailing can not be found on the server.
  • access: public
true unlock ([bool $blForceForeignLock = false])
  • bool $blForceForeignLock: true
    • release foreign and own locks, false - release only own locks (locks held by the current session). May be omitted, defaults to false.
updateFilterId (line 441)

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.

void updateFilterId (int $iFilterId)
  • int $iFilterId: the filter id, 0 means that no filter is set.
updateFilterIds (line 487)

Sets the filters used as the sending filters of this trigger mailing, concatenated using the given concatenation type.

  • FilterConcatenationType::AND(),
  • FilterConcatenationType::OR() or
  • FilterConcatenationType::NOT_IN()
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. The possible types are:

  • FilterConcatenationType::AND(),
  • FilterConcatenationType::OR() or
  • FilterConcatenationType::NOT_IN()
For more information on Filters, see the Inx_Api_Filter_Filter documentation.

  • see: Inx_Api_Filter_Filter
  • throws: Inx_Api_IllegalArgumentException if the concatenation type is UNKNOWN.
  • access: public
void updateFilterIds ( $filterIds, Inx_Api_TriggerMailing_FilterConcatenationType $oConcatinationType)
updateName (line 551)

Sets the name of this trigger mailing.

Sets the name of this trigger mailing.

  • access: public
void updateName (string $sName)
  • string $sName: the name of this trigger mailing.
updatePriority (line 519)

Sets the value of the X-Priority header.

Sets the value of the X-Priority header. Allowed values are:

  • null - not specified, the X-Priority header will not be set
  • 5 - lowest priority
  • 4 - low priority
  • 3 - normal priority
  • 2 - high priority
  • 1 - highest priority

  • access: public
void updatePriority (int $iPriority)
  • int $iPriority: the value of the X-Priority header, or null if the priority is not set.
updateSubject (line 535)

Sets the subject of this trigger mailing.

Sets the subject of this trigger mailing.

  • access: public
void updateSubject (string $sSubject)
  • string $sSubject: the subject of this trigger mailing.
updateTriggerDescriptor (line 601)

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.

  • access: public
void updateTriggerDescriptor (Inx_Api_TriggerMailing_Descriptor_TriggerDescriptor $triggerDescriptor)

Inherited Methods

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