Interface Inx_Api_Bounce_Bounce

Description

An Inx_Api_Bounce_Bounce object contains information related to a bounce.

An Inx_Api_Bounce_Bounce object contains information related to a bounce. With this object you can access data of the bounced mail as well as the bounce message itself. For example you can retrieve the id of the recipient, the mailing id or the content of the bounce message. A bounce message or notification is an error message automatically generated by a destination mail server when a mail cannot be delivered. There are two categories of bounces: hard bounces and soft bounces. A hard bounce indicates a permanent delivery problem (e.g. an unknown email address). A soft bounce indicates a temporary delivery problem (e.g. the recipient inbox disk quota is exceeded).

Note: The usage of bounces requires the api user right: Inx_Api_UserRights::ERRORMAIL_FEATURE_USE

For an example on how to use bounces, see the Inx_Api_Bounce_BounceManager documentation.

  • version: $Revision: 9482 $ $Date: 2007-12-18 16:42:11 +0200 (An, 18 Grd 2007) $ $Author: vladas $
  • see: Inx_Api_Bounce_BounceManager
  • since: API 1.4.3

Located in /Api/Bounce/Bounce.php (line 27)

Inx_Api_BusinessObject
   |
   --Inx_Api_Bounce_Bounce
Class Constant Summary
Method Summary
Methods
getBoolean (line 256)

Returns the Boolean value for the given recipient Attribute.

Returns the Boolean value for the given recipient Attribute.

  • return: the Boolean value.
  • since: API 1.6.1
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type bool.
  • access: public
bool getBoolean (Inx_Api_Recipient_Attribute $attr)
getCategory (line 71)

Returns the category of this bounce.

Returns the category of this bounce. May be one of:

  • CATEGORY_HARD_BOUNCE
  • CATEGORY_SOFT_BOUNCE
  • CATEGORY_UNKNOWN_BOUNCE

  • return: the category of this bounce.
  • access: public
int getCategory ()
getDate (line 220)

Returns the date value for the given recipient Attribute.

Returns the date value for the given recipient Attribute.

  • return: the date value as ISO 8601 formatted date string.
  • since: API 1.6.1
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type date.
  • access: public
string getDate (Inx_Api_Recipient_Attribute $attr)
getDatetime (line 208)

Returns the datetime value for the given recipient Attribute.

Returns the datetime value for the given recipient Attribute.

  • return: the datetime value as ISO 8601 formatted datetime string.
  • since: API 1.6.1
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type datetime.
  • access: public
string getDatetime (Inx_Api_Recipient_Attribute $attr)
getDouble (line 244)

Returns the Double value for the given recipient Attribute.

Returns the Double value for the given recipient Attribute.

  • return: the Double value.
  • since: API 1.6.1
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type double.
  • access: public
double getDouble (Inx_Api_Recipient_Attribute $attr)
getHeaders (line 142)

Returns the header of the bounce message as string.

Returns the header of the bounce message as string.

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

Returns the integer value for the given recipient Attribute.

Returns the integer value for the given recipient Attribute.

  • return: the integer value.
  • since: API 1.6.1
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type int.
  • access: public
int getInteger (Inx_Api_Recipient_Attribute $attr)
getListId (line 119)

Returns the list id of the list in which the bounce occurred.

Returns the list id of the list in which the bounce occurred.

  • return: the list id.
  • access: public
int getListId ()
getMailingId (line 127)

Returns the id of the bounced mailing.

Returns the id of the bounced mailing.

  • return: the mailing id.
  • access: public
int getMailingId ()
getMatchedEmailAddress (line 158)

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.
  • since: API 1.6.1
  • access: public
string getMatchedEmailAddress ()
getMIMEMessageAsStream (line 150)

Returns the complete bounce message as mime message stream.

Returns the complete bounce message as mime message stream.

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

Returns the Object value for the given recipient Attribute.

Returns the Object value for the given recipient Attribute.

  • return: the value.
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • since: API 1.6.1
  • access: public
mixed getObject (Inx_Api_Recipient_Attribute $attr)
getReceptionDate (line 79)

Returns the date when the bounce occurred as ISO 8601 formatted date string.

Returns the date when the bounce occurred as ISO 8601 formatted date string.

  • return: the date of the bounce message as ISO 8601 formatted date string.
  • access: public
string getReceptionDate ()
getRecipientId (line 111)

Returns the recipient id for which the bounce occurred.

Returns the recipient id for which the bounce occurred.

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

Returns the state of the recipient for the current bounce. The possible recipient states are:

Returns the state of the recipient for the current bounce.
The possible recipient states are:

  • 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.
  • since: API 1.6.1
  • access: public
int getRecipientState ()
getSender (line 87)

Returns the sender address.

Returns the sender address.

  • return: the sender address as string.
  • access: public
string getSender ()
getSendingId (line 135)

Returns the id of the bounced sending.

Returns the id of the bounced sending. Returns null if the sending cannot be determined.

  • return: the sending id.
  • access: public
long|null getSendingId ()
getString (line 196)

Returns the string value for the given recipient Attribute.

Returns the string value for the given recipient Attribute.

  • return: the string value.
  • since: API 1.6.1
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type string.
  • access: public
string getString (Inx_Api_Recipient_Attribute $attr)
getSubject (line 95)

Returns the subject of the bounce message.

Returns the subject of the bounce message.

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

Returns the bounce message content as text.

Returns the bounce message content as text.

  • return: the bounce message content as string.
  • access: public
string getTextContent ()
getTime (line 232)

Returns the time value for the given recipient Attribute.

Returns the time value for the given recipient Attribute.

  • return: the time value as ISO 8601 formatted time string.
  • since: API 1.6.1
  • throws: Inx_Api_IllegalArgumentException if the requested attribute was not fetched.
  • throws: Inx_Api_IllegalStateException if the requested attribute is not of type time.
  • access: public
string getTime (Inx_Api_Recipient_Attribute $attr)

Inherited Methods

Inherited From Inx_Api_BusinessObject

Inx_Api_BusinessObject::commitUpdate()
Inx_Api_BusinessObject::getId()
Inx_Api_BusinessObject::reload()
Class Constants
CATEGORY_AUTO_RESPONDER_BOUNCE = 3 (line 42)

This category represents a bounce of auto responder type.

This category represents a bounce of auto responder type.

CATEGORY_HARD_BOUNCE = 0 (line 30)

This category represents a hard bounce.

This category represents a hard bounce. A common reason for a hard bounce is an invalid email address.

CATEGORY_SOFT_BOUNCE = 1 (line 36)

This category represents a soft bounce. inbox disk quota.

This category represents a soft bounce. Soft bounces may occur due to temporary problems like exceeded recipient inbox disk quota.

CATEGORY_SPAM_BOUNCE = 4 (line 45)

This category represents a bounce of spam type.

This category represents a bounce of spam type.

CATEGORY_UNKNOWN_BOUNCE = 2 (line 39)

This category represents a bounce of unknown type.

This category represents a bounce of unknown type.

RECIPIENT_STATE_DELETED = 2 (line 57)

State for non existing (deleted) recipient.

State for non existing (deleted) recipient.

RECIPIENT_STATE_EXISTENT = 1 (line 54)

State for existent recipient.

State for existent recipient.

RECIPIENT_STATE_UNKNOWN = 0 (line 51)

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

  1. 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:21 +0200 by phpDocumentor 1.3.2