Interface Inx_Api_Action_UnsubscriptionCommand

Description

Use the Inx_Api_Action_UnsubscriptionCommand to unsubscribe the recipient from the specified standard list or unsubscribe the recipient from all standard lists.

Use the Inx_Api_Action_UnsubscriptionCommand to unsubscribe the recipient from the specified standard list or unsubscribe the recipient from all standard lists.

  • version: $Revision: 9482 $ $Date: 2007-12-18 16:42:11 +0200 (An, 18 Grd 2007) $ $Author: vladas $
  • see: Inx_Api_Action_CommandFactory
  • since: API 1.2.0

Located in /Api/Action/UnsubscriptionCommand.php (line 16)

Inx_Api_Action_Command
   |
   --Inx_Api_Action_UnsubscriptionCommand
Class Constant Summary
Method Summary
Methods
getCmdType (line 46)

Returns the command type:

Returns the command type: 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 36)

Returns the id of the list context. is CMD_TYPE_UNSUBSCRIBE.

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

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

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

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

  • return: true if the unsubscription processing is enabled, false otherwise.
  • access: public
bool isProcessingEnabled ()
Class Constants
CMD_TYPE_UNSUBSCRIBE = 6 (line 22)

Command type: Unsubscribe from a standard list.

Command type: Unsubscribe from a standard list.

CMD_TYPE_UNSUBSCRIBE_ALL = 2 (line 27)

Command type: Unsubscribe from all standard lists.

Command type: Unsubscribe from all standard lists.

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