Interface Inx_Api_Action_SubscriptionCommand

Description

Use the Inx_Api_Action_SubscriptionCommand to subscribe the recipient to the specified standard list.

Use the Inx_Api_Action_SubscriptionCommand to subscribe the recipient to the specified standard list.

  • 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/SubscriptionCommand.php (line 15)

Inx_Api_Action_Command
   |
   --Inx_Api_Action_SubscriptionCommand
Class Constant Summary
Method Summary
Methods
getCmdType (line 38)

Returns the command type:

Returns the command type: Inx_Api_Action_SubUnsubscriptionCommand::CMD_TYPE_SUBSCRIBE,

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

Returns the id of the list context.

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

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

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

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

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

Command type: Subscribe to a standard list.

Command type: Subscribe to a standard list.

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