An Inx_Api_Action_Action is a powerful tool which can manipulate or send a mail to a recipient for which an event has occurred. when the event occurs. for example, be configured to respond automatically to flame mails.
An Inx_Api_Action_Action is a powerful tool which can manipulate or send a mail to a recipient for which an event has occurred. To do so, an Inx_Api_Action_Action has a list of commands that will be executed when the event occurs. Using this pattern, complex actions may be created. An Inx_Api_Action_Action could, for example, be configured to respond automatically to flame mails. Inx_Api_Action_Actions can be accessed using the Inx_Api_Action_ActionManager.
The different types of commands are:
There are different event types which are triggered by inxmail.
System-wide events (the owner is the SystemListContext):
ListContext-specific events (the owner is a StandardListContext or a FilterListContext):
Note: The usage of Inx_Api_Action_Actions requires the api user right: Inx_Api_UserRights::ACTION_FEATURE_USE
For an example on how to use actions, see the Inx_Api_Action_ActionManager documentation.
Located in /Api/Action/Action.php (line 59)
Inx_Api_BusinessObject | --Inx_Api_Action_Action
Returns the commands this action will execute on the specified event.
Returns the commands this action will execute on the specified event.
Returns the event type of this action.
Returns the event type of this action. Can be one of the event type constants defined in the
Returns the id of the list context which this action belongs to.
Returns the id of the list context which this action belongs to.
Returns the unique name of this action.
Returns the unique name of this action.
Sets the commands this action will execute on the specified event.
Sets the commands this action will execute on the specified event.
Sets the event type of this action.
Sets the event type of this action. Can be one of the event type constants defined in the
Sets the name of this action. Please note, that as of Inxmail Professional version 4. action will cause an Inx_Api_UpdateException to be thrown on commit. name that is already in use also triggers an Inx_Api_UpdateException.
Sets the name of this action.
Please note, that as of Inxmail Professional version 4.4.1, creating an action with the same name as an existing action will cause an Inx_Api_UpdateException to be thrown on commit. Updating an existing action to a new name that is already in use also triggers an Inx_Api_UpdateException.
Inherited From Inx_Api_BusinessObject
Inx_Api_BusinessObject::commitUpdate()
Inx_Api_BusinessObject::getId()
Inx_Api_BusinessObject::reload()
Constant for the commands attribute.
Constant for the commands attribute. Used by the
Constant for the event type attribute.
Constant for the event type attribute. Used by the
Constant for the list context attribute.
Constant for the list context attribute. Used by the
Constant for the name attribute.
Constant for the name attribute. Used by the
Constant for event type: AUTO_RESPONDER_BOUNCE - An auto-responder mail is received through the bounce mailbox.
Constant for event type: AUTO_RESPONDER_BOUNCE - An auto-responder mail is received through the bounce mailbox.
Constant for event type: AUTO_RESPONDER_REPLY - An auto-responder mail is received through the normal mailbox.
Constant for event type: AUTO_RESPONDER_REPLY - An auto-responder mail is received through the normal mailbox.
Constant for event type: CLICK - A link in an email is clicked.
Constant for event type: CLICK - A link in an email is clicked.
Constant for event type: FLAME_REPLY - A flame mail is received through the normal mailbox.
Constant for event type: FLAME_REPLY - A flame mail is received through the normal mailbox.
Constant for event type: HARD_BOUNCE - A hard bounce mail is received.
Constant for event type: HARD_BOUNCE - A hard bounce mail is received.
Constant for event type: NEWSLETTER_SENT - A newsletter was sent.
Constant for event type: NEWSLETTER_SENT - A newsletter was sent.
Constant for event type: SINGLE_MAIL_SENT - A single mail was sent.
Constant for event type: SINGLE_MAIL_SENT - A single mail was sent.
Constant for event type: SOFT_BOUNCE - A soft bounce mail is received.
Constant for event type: SOFT_BOUNCE - A soft bounce mail is received.
Constant for event type: SUBSCRIBE - A recipient was successfully subscribed.
Constant for event type: SUBSCRIBE - A recipient was successfully subscribed.
Constant for event type: UNKNOWN_BOUNCE - An unknown mail is detected through the bounce mailbox.
Constant for event type: UNKNOWN_BOUNCE - An unknown mail is detected through the bounce mailbox.
Constant for event type: UNKNOWN_REPLY - An unknown mail is detected through the normal mailbox.
Constant for event type: UNKNOWN_REPLY - An unknown mail is detected through the normal mailbox.
Constant for event type: UNSUBSCRIBE - A recipient was successfully unsubscribed.
Constant for event type: UNSUBSCRIBE - A recipient was successfully unsubscribed.
Documentation generated on Thu, 17 Sep 2015 14:27:19 +0200 by phpDocumentor 1.3.2