Interface Inx_Api_Property_PropertyNames

Description

The Inx_Api_Property_PropertyNames interface defines the properties which can be set by the API.

The Inx_Api_Property_PropertyNames interface defines the properties which can be set by the API. Not all properties are available for all list types. See the documentation of a specific property for its list type availability.

  • version: $Revision: 9497 $ $Date: 2007-12-19 17:03:25 +0200 (Tr, 19 Grd 2007) $ $Author: aurimas $
  • see: Inx_Api_Property_Property

Located in /Api/Property/PropertyNames.php (line 16)


	
			
Class Constant Summary
 APPROVAL_ACTIVE = "ApprovalActive"
 FORMAT_FRACTION_DIGITS = "floatDecimalPlacesProperty"
 FORMAT_LINEBREAK = "editor-max-columns"
 FORMAT_LOCALE = "listFormatLocale"
 FORMAT_SEPERATOR = "floatDecimalSeperatorProperty"
 HARDBOUNCE_ACTIVE = "HardbounceActive"
 HARDBOUNCE_THRESHOLD = "HardbounceThreshold"
 HTML_PREVIEW = "html-preview"
 LINK_URL = "RedirectLinkUrl"
 MAIL_ENCODING = "charset"
 MAIL_FORMAT_CHOICE = "email-format"
 MAIL_REPLY_ADDRESS = "reply-address"
 MAIL_SENDER_ADDRESS = "sender-address"
 MAIL_TEST_ADDRESS = "test-recipient"
 SENDING_MAILS_PER_HOUR = "sendrate"
 SERVER_NAME = "RedirectServerHostName"
 SERVER_PORT = "RedirectServerHostPort"
 SERVER_URL = "RedirectServerUrl"
 SYSTEM_MAIL_SENDER_ADDRESS = "SystemSenderEmail"
 TRACKING_PROXY = "TrackingProxy"
 UNSUBSCRIBE_NOT_IN_LIST = "UnsubscribeNotInList"
Class Constants
APPROVAL_ACTIVE = "ApprovalActive" (line 198)

Constant for the approval property.

Constant for the approval property. The approval property defines if the approval of of mailings is activated and how it is done. This special property may be set using the Inx_Api_Property_PropertyFormatter provided by Inx_Api_Property_Property::getFormatter(). This property is available for the following list types:

  • Standard list
  • Filter list
  • System list

FORMAT_FRACTION_DIGITS = "floatDecimalPlacesProperty" (line 40)

Constant for the fraction digits property.

Constant for the fraction digits property. The fraction digits property defines how many decimal fraction digits shall be viewed of a floating point (or floating comma) value. This property is available for the following list types:

  • Standard list
  • Filter list
  • System list

FORMAT_LINEBREAK = "editor-max-columns" (line 63)

Constant for the line break property.

Constant for the line break property. The line break property defines after how many characters a text mailing line will break automatically. This property is available for the following list types:

  • Standard list
  • Filter list

FORMAT_LOCALE = "listFormatLocale" (line 27)

Constant for the locale property.

Constant for the locale property. The locale property defines how numbers and dates are formatted. This property is available for the following list types:

  • Standard list
  • Filter list
  • System list

FORMAT_SEPERATOR = "floatDecimalSeperatorProperty" (line 52)

Constant for the decimal separator property.

Constant for the decimal separator property. The decimal separator property defines which character is used to separate a decimal number from its fractions. This property is available for the following list types:

  • Standard list
  • Filter list
  • System list

HARDBOUNCE_ACTIVE = "HardbounceActive" (line 181)

Constant for the hard bounce active property.

Constant for the hard bounce active property. The hard bounce active property defines if recipients are automatically marked as unreachable if a specific threshold (see HARDBOUNCE_THRESHOLD) is reached. This property is available for the following list types:

  • Administration list

  • since: API 1.6.0
HARDBOUNCE_THRESHOLD = "HardbounceThreshold" (line 168)

Constant for the hard bounce threshold property.

Constant for the hard bounce threshold property. The hard bounce threshold property defines how many hard bounces may be received before a recipient is marked as unreachable. A value of 0 means the recipient will never be marked as unreachable automatically. This property is available for the following list types:

  • Administration list

  • since: API 1.6.0
HTML_PREVIEW = "html-preview" (line 149)
  • deprecated: this property will be removed in further versions.
LINK_URL = "RedirectLinkUrl" (line 226)

Constant for the link URL property.

Constant for the link URL property. The link URL property defines the address of the Inxmail customer. This value is used for link tracking. This property is available for the following list types:

  • Standard list
  • Filter list
  • Administration list

  • since: API 1.6.1
MAIL_ENCODING = "charset" (line 75)

Constant for the character set property.

Constant for the character set property. The character set property defines how characters are encoded (e.g. UTF-8). This property is available for the following list types:

  • Standard list
  • Filter list
  • System list

MAIL_FORMAT_CHOICE = "email-format" (line 89)

Constant for the mail format property.

Constant for the mail format property. The mail format property defines which formats (plain text, HTML text or multipart) may be used in a specific list. This special property can be set using the Inx_Api_Property_FormatChoicePropertyFormatter. This property is available for the following list types:

  • Standard list
  • Filter list

MAIL_REPLY_ADDRESS = "reply-address" (line 111)

Constant for the reply address property.

Constant for the reply address property. The reply address property defines which address the recipient may use for replies. This property is available for the following list types:

  • Standard list
  • Filter list

MAIL_SENDER_ADDRESS = "sender-address" (line 100)

Constant for the sender address property.

Constant for the sender address property. The sender address property defines which which address is used to send the mailings of a list. This property is available for the following list types:

  • Standard list
  • Filter list

MAIL_TEST_ADDRESS = "test-recipient" (line 154)
  • deprecated: this property will be removed in further versions.
SENDING_MAILS_PER_HOUR = "sendrate" (line 144)

Constant for the sending performance property.

Constant for the sending performance property. The sending performance property defines how many mails may be sent per hour at a maximum. The value has to be set in steps of 3600, where 0 means no limit at all. This property is available for the following list types:

  • Standard list
  • Filter list
  • System list

SERVER_NAME = "RedirectServerHostName" (line 126)
  • deprecated: this property will be removed in further versions.
SERVER_PORT = "RedirectServerHostPort" (line 131)
  • deprecated: this property will be removed in further versions.
SERVER_URL = "RedirectServerUrl" (line 212)

Constant for the server URL property.

Constant for the server URL property. The server URL property defines the address of the Inxmail customer. This value is important for JSPs. This property is available for the following list types:

  • Standard list
  • Filter list
  • Administration list

  • since: API 1.6.1
SYSTEM_MAIL_SENDER_ADDRESS = "SystemSenderEmail" (line 121)

Constant for the system mail sender address property.

Constant for the system mail sender address property. The system mail sender address property defines which address is used to send system mails. This property is available for the following list types:

  • Administration list

TRACKING_PROXY = "TrackingProxy" (line 238)

Constant for the tracking proxy property.

Constant for the tracking proxy property. The tracking proxy property defines if a tracking proxy shall be used and which one to use. This property is available for the following list types:

  • Administration list

  • since: API 1.6.1
UNSUBSCRIBE_NOT_IN_LIST = "UnsubscribeNotInList" (line 251)

Constant for the Unsubscribe not in list members property.

Constant for the Unsubscribe not in list members property. The Unsubscribe not in list property defines whether it is possible for recipients to unsubscribe from a list they are not member of. This property is available for the following list types:

  • Standard list
  • System list

  • since: API 1.10.1

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