Class Inx_Api_GeneralMailing_MailingType

Description

The Inx_Api_GeneralMailing_MailingType enumeration defines the types of general mailings which may be queried.

The Inx_Api_GeneralMailing_MailingType enumeration defines the types of general mailings which may be queried.

Located in /Api/GeneralMailing/MailingType.php (line 13)


	
			
Method Summary
static void ACTION_MAILING ()
static array mailingTypeToIdArray ([ $types = null])
static void REGULAR_MAILING ()
static void SEQUENCE_MAILING ()
static void SPLIT_TEST_MAILING ()
static void TIME_TRIGGER_MAILING ()
static void UNKNOWN ()
static array values ()
int getId ()
Methods
static method ACTION_MAILING (line 37)

The ACTION_MAILING type is used for action trigger mailings.

The ACTION_MAILING type is used for action trigger mailings.

  • access: public
static void ACTION_MAILING ()
static method byId (line 129)

Returns the Inx_Api_GeneralMailing_MailingType corresponding to the given $iId.

Returns the Inx_Api_GeneralMailing_MailingType corresponding to the given $iId. If the ID is unknown, the UNKNOWN type will be returned. The ID is used for transmission purposes and should not be used inside client code.

  • return: the Inx_Api_GeneralMailing_MailingType corresponding to the given ID.
  • access: public
static Inx_Api_GeneralMailing_MailingType byId (int $iId)
  • int $iId: the ID of the Inx_Api_GeneralMailing_MailingType to retrieve.
static method mailingTypeToIdArray (line 147)

Returns an array of Inx_Api_GeneralMailing_MailingType IDs corresponding to the given Inx_Api_GeneralMailing_MailingType array.

Returns an array of Inx_Api_GeneralMailing_MailingType IDs corresponding to the given Inx_Api_GeneralMailing_MailingType array. The IDs are used for transmission purposes and should not be used inside client code.

  • return: an array of Inx_Api_GeneralMailing_MailingType IDs
  • access: public
static array mailingTypeToIdArray ([ $types = null])
  • array $types: an array of Inx_Api_GeneralMailing_MailingType to determine the IDs from
static method REGULAR_MAILING (line 26)

The REGULAR_MAILING type is used for regular newsletter mailings.

The REGULAR_MAILING type is used for regular newsletter mailings.

  • access: public
static void REGULAR_MAILING ()
static method SEQUENCE_MAILING (line 82)

The SEQUENCE_MAILING type is used for sequence mailings.

The SEQUENCE_MAILING type is used for sequence mailings.

  • access: public
static void SEQUENCE_MAILING ()
static method SPLIT_TEST_MAILING (line 71)

The SPLIT_TEST_MAILING type is used for split test mailings.

The SPLIT_TEST_MAILING type is used for split test mailings.

  • access: public
static void SPLIT_TEST_MAILING ()
static method SUBSCRIPTION_TRIGGER_MAILING (line 60)

The SUBSCRIPTION_TRIGGER_MAILING type is used for subscription and unsubscription trigger mailings, e.

The SUBSCRIPTION_TRIGGER_MAILING type is used for subscription and unsubscription trigger mailings, e.g. welcome and verification mailing.

  • access: public
static void SUBSCRIPTION_TRIGGER_MAILING ()
static method TIME_TRIGGER_MAILING (line 48)

The TIME_TRIGGER_MAILING type is used for time trigger mailings, e.

The TIME_TRIGGER_MAILING type is used for time trigger mailings, e.g. birthday and interval mailing.

  • access: public
static void TIME_TRIGGER_MAILING ()
static method UNKNOWN (line 93)

The UNKNOWN type indicates a version mismatch between API and server.

The UNKNOWN type indicates a version mismatch between API and server.

  • access: public
static void UNKNOWN ()
static method values (line 167)

Returns an array containing all available Inx_Api_GeneralMailing_MailingTypes including UNKNOWN.

Returns an array containing all available Inx_Api_GeneralMailing_MailingTypes including UNKNOWN.

  • return: an array containing all available Inx_Api_GeneralMailing_MailingTypes including UNKNOWN.
  • access: public
static array values ()
getId (line 115)

Returns the ID of the Inx_Api_GeneralMailing_MailingType.

Returns the ID of the Inx_Api_GeneralMailing_MailingType. The ID is used for transmission purposes and should not be used inside client code.

  • return: the ID of the Inx_Api_GeneralMailing_MailingType.
  • access: public
int getId ()

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