Interface Inx_Api_Action_SendMailCommand

Description

Use the Inx_Api_Action_SendMailCommand to send a mailing to a recipient.

Use the Inx_Api_Action_SendMailCommand to send a mailing to a recipient. This command can be configured to either send a specific mailing or to send the last mailing (newsletter) in the recipients 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/SendMailCommand.php (line 17)

Inx_Api_Action_Command
   |
   --Inx_Api_Action_SendMailCommand
Class Constant Summary
Method Summary
Methods
getCmdType (line 37)

Returns the command type: Inx_Api_Action_SendMailCommand::CMD_TYPE_SPECIFIC_MAILING or Inx_Api_Action_SendMailCommand::CMD_TYPE_LAST_MAILING.

Returns the command type: Inx_Api_Action_SendMailCommand::CMD_TYPE_SPECIFIC_MAILING or Inx_Api_Action_SendMailCommand::CMD_TYPE_LAST_MAILING.

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

Returns the id of the standard or filter list context associated with this command.

Returns the id of the standard or filter list context associated with this command.

  • return: the id of the list context
  • access: public
int getListContextId ()
getMailingId (line 54)

Returns the id of the mailing associated with this command. Inx_Api_Action_SendMailCommand::CMD_TYPE_SPECIFIC_MAILING.

Returns the id of the mailing associated with this command. Only specified if the command type is Inx_Api_Action_SendMailCommand::CMD_TYPE_SPECIFIC_MAILING.

  • return: the id of the mailing.
  • access: public
int getMailingId ()
Class Constants
CMD_TYPE_LAST_MAILING = 1 (line 28)

Command type: Send the last newsletter.

Command type: Send the last newsletter.

CMD_TYPE_SPECIFIC_MAILING = 0 (line 23)

Command type: Send a specific mailing.

Command type: Send a specific mailing.

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