Interface Inx_Api_Action_Command

Description

The Inx_Api_Action_Command interface identifies commands which are executed by an Inx_Api_Action_Action when the event associated with the action is triggered.

The Inx_Api_Action_Command interface identifies commands which are executed by an Inx_Api_Action_Action when the event associated with the action is triggered. Inx_Api_Action_Commands can be used to manipulate a recipient or to send a single mailing to that recipient. The different types of commands are:

  • Inx_Api_Action_DeleteRecipientCommand - Permanently remove the recipient.
  • Inx_Api_Action_SendMailCommand - Send a mailing to the recipient.
  • Inx_Api_Action_SetValueCommand - Set an attribute value of the recipient.
  • Inx_Api_Action_SubscriptionCommand - Subscribe the recipient.
  • Inx_Api_Action_UnsubscriptionCommand - Unsubscribe the recipient.

For an example on how to use commands and actions, see the Inx_Api_Action_ActionManager documentation.

Located in /Api/Action/Command.php (line 29)


	
			
Direct descendents
Class Description
Inx_Api_Action_DeleteRecipientCommand Use the Inx_Api_Action_DeleteRecipientCommand to permanently delete a recipient from the system.
Inx_Api_Action_SendActionMailCommand Use the Inx_Api_Action_SendActionMailCommand to send an action mailing to a recipient. mailing must be approved in order to be used.
Inx_Api_Action_SendMailCommand Use the Inx_Api_Action_SendMailCommand to send a mailing to a recipient.
Inx_Api_Action_SetValueCommand Use the Inx_Api_Action_SetValueCommand to set an attribute value.
Inx_Api_Action_SubscriptionCommand Use the Inx_Api_Action_SubscriptionCommand to subscribe the recipient to the specified standard list.
Inx_Api_Action_SubUnsubscriptionCommand Use the Inx_Api_Action_SubUnsubscriptionCommand to subscribe/unsubscribe a recipient to/from the specified standard list (CMD_TYPE_SUBSCRIBE and CMD_TYPE_UNSUBSCRIBE) or unsubscribe a recipient from all standard lists (MD_TYPE_UNSUBSCRIBE_ALL).
Inx_Api_Action_UnsubscriptionCommand Use the Inx_Api_Action_UnsubscriptionCommand to unsubscribe the recipient from the specified standard list or unsubscribe the recipient from all standard lists.

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