Interface Inx_Api_Action_SubUnsubscriptionCommand

Description

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).

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).

  • version: $Revision$ $Date$ $Author$
  • see: Inx_Api_Action_CommandFactory
  • deprecated: Use Inx_Api_Action_SubscriptionCommand and Inx_Api_Action_UnsubscriptionCommand instead.
  • since: API 1.2.0

Located in /Api/Action/SubUnsubscriptionCommand.php (line 15)

Inx_Api_Action_Command
   |
   --Inx_Api_Action_SubUnsubscriptionCommand
Class Constant Summary
Method Summary
Methods
getCmdType (line 50)

Returns the command type:

Returns the command type: Inx_Api_Action_SubUnsubscriptionCommand::CMD_TYPE_SUBSCRIBE, Inx_Api_Action_SubUnsubscriptionCommand::CMD_TYPE_UNSUBSCRIBE or Inx_Api_Action_SubUnsubscriptionCommand::CMD_TYPE_UNSUBSCRIBE_ALL

  • return: the command type.
  • access: public
int getCmdType ()
getListContextId (line 39)

Returns the id of the list context. is CMD_TYPE_SUBSCRIBE or CMD_TYPE_UNSUBSCRIBE.

Returns the id of the list context. Only specified if the command type is CMD_TYPE_SUBSCRIBE or CMD_TYPE_UNSUBSCRIBE.

  • return: the id of the list context.
  • access: public
int getListContextId ()
isProcessingEnabled (line 60)

Specifies if the subscription/unsubscription processing is enabled or the recipient will be subscribed/unsubscribed directly. will send a verification email to the recipient.

Specifies if the subscription/unsubscription processing is enabled or the recipient will be subscribed/unsubscribed directly. If processing and double opt in (DOI) / double opt out (DOO) are enabled, this will send a verification email to the recipient.

  • return: true if the subscription/unsubscription processing is enabled, false otherwise.
  • access: public
bool isProcessingEnabled ()
Class Constants
CMD_TYPE_SUBSCRIBE = 0 (line 20)

Command type: Subscribe to a standard list.

Command type: Subscribe to a standard list.

CMD_TYPE_UNSUBSCRIBE = 1 (line 25)

Command type: Unsubscribe from a standard list.

Command type: Unsubscribe from a standard list.

CMD_TYPE_UNSUBSCRIBE_ALL = 2 (line 30)

Command type: Unsubscribe from all standard lists.

Command type: Unsubscribe from all standard lists.

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