The TriggerMailingAttribute enumeration defines the attributes of trigger mailings which are used for the ordering of result sets and to identify the error source of an Inx_Api_UpdateException.
The TriggerMailingAttribute enumeration defines the attributes of trigger mailings which are used for the ordering of result sets and to identify the error source of an Inx_Api_UpdateException. To find out if an attribute may be used for ordering, call the isOrderAttribute() method.
A note for programmers who are not familiar with the concept of enumerations: Enumerations or enumerated types are basically a fixed set of named values. They are usually used to define a couple of legitimate values in a specific context and serve a purpose similar to integer constants. The advantage of enumerations is, that you cannot specify any "weird" values because every value has to be an instance of the enumerated type. It is also possible to associate data or even behaviour (methods) with the values. PHP does not support such a language feature like Java and C# do. In most languages the named values are a sort of constant whose value is an instance of the enumerated type. In PHP a constant cannot contain a reference type. Therefore, we implemented enumerations as classes with private constructor and methods which return the named values. Be aware that the objects returned by the static methods are always the same object. That way it is possible to use the identity operator (===) on these objects and use them comfortably in switch statements.
Located in /Api/TriggerMailing/TriggerMailingAttribute.php (line 31)
Constant for the activation datetime attribute.
Constant for the activation datetime attribute. Used for ordering by the TriggerMailingManager
Returns the TriggerMailingAttribute corresponding to the given id. UNKNOWN attribute will be returned. inside client code.
Returns the TriggerMailingAttribute corresponding to the given id. If the id is unknown, the UNKNOWN attribute will be returned. The ID is used for transmission purposes and should not be used inside client code.
The default attribute used for ordering and as error source if no specific attribute is known or given.
The default attribute used for ordering and as error source if no specific attribute is known or given.
Constant for the trigger descriptor attribute. source.
Constant for the trigger descriptor attribute. Used by the UpdateException to identify the error source.
Constant for the filter id attribute.
Constant for the filter id attribute.
Returns an array of the TriggerMailingAttributes which can be used for ordering.
Returns an array of the TriggerMailingAttributes which can be used for ordering.
Constant for the HTML text attribute.
Constant for the HTML text attribute.
Constant for the HTML text style XML content attribute.
Constant for the HTML text style XML content attribute.
Constant for the mailing content (MIME) type attribute.
Constant for the mailing content (MIME) type attribute. This constant is used internally only.
Constant for the mailing feature id.
Constant for the mailing feature id. This constant is used internally only.
Constant for the mailing list id attribute.
Constant for the mailing list id attribute. This constant is used internally only.
Constant for the modification datetime attribute.
Constant for the modification datetime attribute. Used for ordering by the TriggerMailingManager.
Constant for the name attribute.
Constant for the name attribute. Used for ordering by the TriggerMailingManager
Constant for the plain text attribute.
Constant for the plain text attribute.
Constant for the plain text style XML content attribute.
Constant for the plain text style XML content attribute.
Constant for the priority attribute.
Constant for the priority attribute.
Constant for the recipient address attribute.
Constant for the recipient address attribute.
Constant for the reply address attribute.
Constant for the reply address attribute.
Constant for the sender address attribute.
Constant for the sender address attribute.
Constant for the single send count attribute.
Constant for the single send count attribute. Used for ordering by the TriggerMailingManager
Constant for the style attribute.
Constant for the style attribute. Used by the UpdateException to identify the error source.
Constant for the subject attribute.
Constant for the subject attribute. Used for ordering by the TriggerMailingManager.
Constant for an unknown attribute. be used by the UpdateException to identify the error source.
Constant for an unknown attribute. This attribute indicates a version mismatch between API and server. It might be used by the UpdateException to identify the error source.
Returns an array containing all available TriggerMailingAttributes including UNKNOWN.
Returns an array containing all available TriggerMailingAttributes including UNKNOWN.
Constant for the XML content attribute.
Constant for the XML content attribute.
Returns the ID of the TriggerMailingAttribute. not be used inside client code.
Returns the ID of the TriggerMailingAttribute. The ID is used for transmission purposes and should not be used inside client code.
Returns a bool indicating if this TriggerMailingAttribute can be used for ordering of result sets.
Returns a bool indicating if this TriggerMailingAttribute can be used for ordering of result sets.
Documentation generated on Thu, 17 Sep 2015 14:27:33 +0200 by phpDocumentor 1.3.2