Interface Inx_Api_Inbox_InboxMessage

Description

An Inx_Api_Inbox_InboxMessage object contains information related to a message received through the inbox.

An Inx_Api_Inbox_InboxMessage object contains information related to a message received through the inbox. With this object you can access data of a received reply, auto responder message, flame message or spam message. For example you can retrieve the id of the recipient or the content of the received message. For an example on how to retrieve InboxMessages, see the Inx_Api_Inbox_InboxManager documentation.

Located in /Api/Inbox/InboxMessage.php (line 16)

Inx_Api_BusinessObject
   |
   --Inx_Api_Inbox_InboxMessage
Class Constant Summary
Method Summary
Methods
getBoolean (line 255)

Returns the bool value for the given recipient Attribute.

Returns the bool value for the given recipient Attribute.

  • return: the bool value.
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type bool.
  • throws: Inx_Api_UnknownRecipientException if the recipient state is unknown.
  • access: public
bool getBoolean (Inx_Api_Recipient_Attribute $oAttribute)
getCategory (line 89)

Returns the category of this inbox message.

Returns the category of this inbox message. May be one of:

  • CATEGORY_AUTO_RESPONDER
  • CATEGORY_FLAME
  • CATEGORY_SPAM
  • CATEGORY_UNCATEGORIZED
  • CATEGORY_UNKNOWN

  • return: the category of this inbox message.
  • access: public
int getCategory ()
getDate (line 218)

Returns the date value for the given recipient Attribute.

Returns the date value for the given recipient Attribute. The date will be returned as ISO 8601 formatted date string.

  • return: the date value.
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type date.
  • throws: Inx_Api_UnknownRecipientException if the recipient state is unknown.
  • access: public
string getDate (Inx_Api_Recipient_Attribute $oAttribute)
getDatetime (line 205)

Returns the datetime value for the given recipient Attribute.

Returns the datetime value for the given recipient Attribute. The datetime will be returned as ISO 8601 formatted datetime string.

  • return: the datetime value.
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type datetime.
  • throws: Inx_Api_UnknownRecipientException if the recipient state is unknown.
  • access: public
string getDatetime (Inx_Api_Recipient_Attribute $oAttribute)
getDouble (line 243)

Returns the float value for the given recipient Attribute.

Returns the float value for the given recipient Attribute.

  • return: the float value.
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type float.
  • throws: Inx_Api_UnknownRecipientException if the recipient state is unknown.
  • access: public
float getDouble (Inx_Api_Recipient_Attribute $oAttribute)
getHeaders (line 138)

Returns the header of the message as string.

Returns the header of the message as string.

  • return: the header of the message as string.
  • access: public
string getHeaders ()
getInteger (line 180)

Returns the integer value for the given recipient Attribute.

Returns the integer value for the given recipient Attribute.

  • return: the integer value.
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type int.
  • throws: Inx_Api_UnknownRecipientException if the recipient state is unknown.
  • access: public
int getInteger (Inx_Api_Recipient_Attribute $oAttribute)
getMatchedEmailAddress (line 154)

Returns the matched e-mail address (i.

Returns the matched e-mail address (i.e. the e-mail address of the recipient).

  • return: the e-mail address.
  • access: public
string getMatchedEmailAddress ()
getMIMEMessageAsStream (line 146)

Returns the complete message as mime message stream.

Returns the complete message as mime message stream.

  • return: the mime message as input stream.
  • access: public
Inx_Api_InputStream getMIMEMessageAsStream ()
getObject (line 266)

Returns the value for the given recipient Attribute.

Returns the value for the given recipient Attribute.

  • return: the value.
  • throws: Inx_Api_UnknownRecipientException if the recipient state is unknown.
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • access: public
mixed getObject (Inx_Api_Recipient_Attribute $oAttribute)
getReceptionDate (line 98)

Returns the date when the message was received.

Returns the date when the message was received. The date will be returned as ISO 8601 formatted datetime string.

  • return: the date of the message reception.
  • access: public
string getReceptionDate ()
getRecipientId (line 130)

Returns the id of the recipient who sent the message.

Returns the id of the recipient who sent the message.

  • return: the recipient id.
  • access: public
int getRecipientId ()
getRecipientState (line 168)

Returns the state of the recipient for the message. RecipientState values:

Returns the state of the recipient for the message.
RecipientState values:

  • RECIPIENT_STATE_UNKNOWN - no attributes are queried or recipient is unknown.
  • RECIPIENT_STATE_EXISTENT - recipient exists.
  • RECIPIENT_STATE_DELETED - recipient is deleted.

  • return: the recipient state.
  • access: public
int getRecipientState ()
getSender (line 106)

Returns the sender address.

Returns the sender address.

  • return: the sender address as string.
  • access: public
string getSender ()
getString (line 192)

Returns the string value for the given recipient Attribute.

Returns the string value for the given recipient Attribute.

  • return: the string value.
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type string.
  • throws: Inx_Api_UnknownRecipientException if the recipient state is unknown.
  • access: public
string getString (Inx_Api_Recipient_Attribute $oAttribute)
getSubject (line 114)

Returns the subject of the received message.

Returns the subject of the received message.

  • return: the subject of the received message as string.
  • access: public
string getSubject ()
getTextContent (line 122)

Returns the message content as text.

Returns the message content as text.

  • return: the message as string.
  • access: public
string getTextContent ()
getTime (line 231)

Returns the time value for the given recipient Attribute.

Returns the time value for the given recipient Attribute. The time will be returned as ISO 8601 formatted time string

  • return: the time value.
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type time.
  • throws: Inx_Api_UnknownRecipientException if the recipient state is unknown.
  • access: public
string getTime (Inx_Api_Recipient_Attribute $oAttribute)

Inherited Methods

Inherited From Inx_Api_BusinessObject

Inx_Api_BusinessObject::commitUpdate()
Inx_Api_BusinessObject::getId()
Inx_Api_BusinessObject::reload()
Class Constants
CATEGORY_AUTO_RESPONDER = 0 (line 23)

This category represents an auto responder message.

This category represents an auto responder message.

CATEGORY_FLAME = 1 (line 31)

This category represents a flame message. language.

This category represents a flame message. A flame message is a message with aggressive content and/or strong language.

CATEGORY_SPAM = 2 (line 38)

This category represents a mail categorized as undesirable by spam/virus checking software

This category represents a mail categorized as undesirable by spam/virus checking software

CATEGORY_UNCATEGORIZED = 3 (line 45)

This category represents an ordinary mail which does not match a specific category.

This category represents an ordinary mail which does not match a specific category.

CATEGORY_UNKNOWN = 4 (line 52)

This category represents a mail of unknown type.

This category represents a mail of unknown type.

RECIPIENT_STATE_DELETED = 2 (line 74)

State for non existing (deleted) recipient.

State for non existing (deleted) recipient.

RECIPIENT_STATE_EXISTENT = 1 (line 67)

State for existent recipient.

State for existent recipient.

RECIPIENT_STATE_UNKNOWN = 0 (line 60)

State for missing recipient information. attributes are specified in the query or in case of an unknown recipient.

State for missing recipient information. This state will be used when no RecipientContext and/or no attributes are specified in the query or in case of an unknown recipient.

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