Interface Inx_Api_Recipient_Attribute

Description

An Inx_Api_Recipient_Attribute contains meta data of recipients.

An Inx_Api_Recipient_Attribute contains meta data of recipients. It is the API equivalent of a column in the Inxmail recipient list view. There are mainly two categories of attributes:

  1. Predefined attributes are created by Inxmail and may not be removed or renamed. The most important attributes of this type are:
    • The id attribute: Contains the id of the recipient
    • The email attribute: Contains the email address of the recipient
    • The key attribute: In general the same as the email attribute
    • The subscription attribute: Contains the subscription date of the recipient - Individual for every list
    • The last modification attribute: Contains the date of the last modification of the recipient
    • The hard bounce attribute: Contains the number of hard bounces received for the recipient
  2. User attributes are created by Inxmail users and may be freely removed or renamed. User attributes give you the ability to treat a recipient according to certain properties. For example you could create an user attribute called 'format' which contains the users preferred mail format. You could then set the mailing format according to this attribute. You could also define an user attribute to store certain interests of the recipient and generate filters (target groups) to send a mailing only to recipients who are interested in the topic covered by the mailing.
All attributes share a common set of properties, which define them. These properties are: <p/>
  • The id: Each attribute has a unique id.
  • The name: Each attribute has an unique name. This name is only retrievable for user attributes, though.
  • The type: The different attribute types are:
    • EMAIL_ATTRIBUTE_TYPE: The email attribute
    • ID_ATTRIBUTE_TYPE: The id attribute
    • SUBSCRIPTION_ATTRIBUTE_TYPE: An attribute that indicates the subscription state for a specific list
    • LAST_MODIFICATION_ATTRIBUTE_TYPE: The last modification date attribute
    • HARDBOUNCE_ATTRIBUTE_TYPE: Contains the number of hard bounces received for a recipient
    • FEATURE_ATTRIBUTE_TYPE: An attribute associated with a feature (agent)
    • USER_ATTRIBUTE_TYPE: An user defined attribute
  • The data type: The different data types are:
    • DATA_TYPE_STRING
    • DATA_TYPE_DATETIME
    • DATA_TYPE_DATE
    • DATA_TYPE_TIME
    • DATA_TYPE_BOOLEAN
    • DATA_TYPE_INTEGER
    • DATA_TYPE_DOUBLE
  • The maximum String length: If the data type is DATA_TYPE_STRING, the attribute can not be longer than the maximum length defined in this property.
  • The list context id: Mainly used by attributes of type SUBSCRIPTION_ATTRIBUTE_TYPE to indicate the list they are responsible for.
  • The feature (agent) id: Some attributes are used by specific features.
  • The accessibility: Only relevant for plug-ins.
<p/> Predefined attributes can easily be retrieved using the various get methods of the Inx_Api_Recipient_RecipientMetaData class. User attributes are retrieved using the Inx_Api_Recipient_RecipientMetaData::getUserAttribute($sName) method and are identified by their unique name. See the Inx_Api_Recipient_RecipientMetaData documentation for more information. <p/> User attributes may be created, removed and renamed using the Inx_Api_Recipient_AttributeManager. For more information on this topic, see the AttributeManager documentation.

Located in /Api/Recipient/Attribute.php (line 79)


	
			
Class Constant Summary
Method Summary
int getDataType ()
int getFeatureId ()
int getId ()
string getName ()
int getType ()
bool isAccessible ()
Methods
getDataType (line 230)

Returns the data type of this attribute.

Returns the data type of this attribute. May be one of:

  • DATA_TYPE_STRING
  • DATA_TYPE_INTEGER
  • DATA_TYPE_DOUBLE
  • DATA_TYPE_BOOLEAN
  • DATA_TYPE_DATETIME
  • DATA_TYPE_DATE
  • DATA_TYPE_TIME

  • return: the data type of this attribute.
  • access: public
int getDataType ()
getFeatureId (line 257)

Returns the feature id of this attribute.

Returns the feature id of this attribute. Only relevant if the attribute type is FEATURE_ATTRIBUTE_TYPE.

  • return: the feature id of this attribute.
  • access: public
int getFeatureId ()
getId (line 187)

Returns the unique id of this attribute.

Returns the unique id of this attribute.

  • return: the unique id of this attribute.
  • access: public
int getId ()
getListContextId (line 248)

Returns the list context id of this attribute.

Returns the list context id of this attribute. Only relevant if the attribute type is SUBSCRIPTION_ATTRIBUTE_TYPE or FEATURE_ATTRIBUTE_TYPE.

  • return: the list context id of this attribute.
  • access: public
int getListContextId ()
getMaxStringLength (line 239)

Returns the maximum length of the string value of this attribute.

Returns the maximum length of the string value of this attribute. Only relevant if the data type is DATA_TYPE_STRING.

  • return: the maximum length of the string value of this attribute.
  • access: public
int getMaxStringLength ()
getName (line 195)

Returns the unique name of this attribute.

Returns the unique name of this attribute.

  • return: the unique name of this attribute.
  • access: public
string getName ()
getType (line 212)

Returns the attribute type of this attribute.

Returns the attribute type of this attribute. May be one of:

  • ID_ATTRIBUTE_TYPE
  • EMAIL_ATTRIBUTE_TYPE
  • USER_ATTRIBUTE_TYPE
  • SUBSCRIPTION_ATTRIBUTE_TYPE
  • LAST_MODIFIED_ATTRIBUTE_TYPE
  • FEATURE_ATTRIBUTE_TYPE

  • return: the attribute type of this attribute.
  • access: public
int getType ()
isAccessible (line 264)

Only relevant in a plug-in api session.

Only relevant in a plug-in api session.

  • return: the accessibility of this attribute.
  • access: public
bool isAccessible ()
Class Constants
DATA_TYPE_BOOLEAN = 4 (line 107)

Constant for the data type Boolean.

Constant for the data type Boolean.

DATA_TYPE_DATE = 11 (line 121)

Constant for the data type Date (without Time).

Constant for the data type Date (without Time).

DATA_TYPE_DATETIME = 10 (line 114)

Constant for the data type Datetime (Date + Time).

Constant for the data type Datetime (Date + Time).

DATA_TYPE_DOUBLE = 3 (line 100)

Constant for the data type Double.

Constant for the data type Double.

DATA_TYPE_INTEGER = 2 (line 93)

Constant for the data type Integer.

Constant for the data type Integer.

DATA_TYPE_STRING = 1 (line 86)

Constant for the data type String.

Constant for the data type String.

DATA_TYPE_TIME = 12 (line 128)

Constant for the data type Time (without Date).

Constant for the data type Time (without Date).

EMAIL_ATTRIBUTE_TYPE = 3 (line 150)

Constant for the email attribute.

Constant for the email attribute.

FEATURE_ATTRIBUTE_TYPE = 1 (line 136)

Constant for attributes used by features.

Constant for attributes used by features.

HARDBOUNCE_ATTRIBUTE_TYPE = 8 (line 179)

Constant for the hard bounce attribute (counter).

Constant for the hard bounce attribute (counter).

  • since: API 1.6.0
ID_ATTRIBUTE_TYPE = 4 (line 157)

Constant for the id attribute.

Constant for the id attribute.

LAST_MODIFICATION_ATTRIBUTE_TYPE = 7 (line 171)

Constant for the last modification attribute.

Constant for the last modification attribute.

SUBSCRIPTION_ATTRIBUTE_TYPE = 2 (line 143)

Constant for attributes containing list subscription information.

Constant for attributes containing list subscription information.

USER_ATTRIBUTE_TYPE = 5 (line 164)

Constant for user defined attributes.

Constant for user defined attributes.

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