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.
Located in /Api/Bounce/Bounce.php (line 27)
Inx_Api_BusinessObject | --Inx_Api_Bounce_Bounce
Returns the Boolean value for the given recipient Attribute.
Returns the Boolean value for the given recipient Attribute.
Returns the category of this bounce.
Returns the category of this bounce. May be one of:
Returns the date value for the given recipient Attribute.
Returns the date value for the given recipient Attribute.
Returns the datetime value for the given recipient Attribute.
Returns the datetime value for the given recipient Attribute.
Returns the Double value for the given recipient Attribute.
Returns the Double value for the given recipient Attribute.
Returns the header of the bounce message as string.
Returns the header of the bounce message as string.
Returns the integer value for the given recipient Attribute.
Returns the integer value for the given recipient Attribute.
Returns the list id of the list in which the bounce occurred.
Returns the list id of the list in which the bounce occurred.
Returns the id of the bounced mailing.
Returns the id of the bounced mailing.
Returns the matched e-mail address (i.
Returns the matched e-mail address (i.e. the e-mail address of the recipient).
Returns the complete bounce message as mime message stream.
Returns the complete bounce message as mime message stream.
Returns the Object value for the given recipient Attribute.
Returns the Object value for the given recipient Attribute.
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.
Returns the recipient id for which the bounce occurred.
Returns the recipient id for which the bounce occurred.
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:
Returns the sender address.
Returns the sender address.
Returns the id of the bounced sending.
Returns the id of the bounced sending. Returns null if the sending cannot be determined.
Returns the string value for the given recipient Attribute.
Returns the string value for the given recipient Attribute.
Returns the subject of the bounce message.
Returns the subject of the bounce message.
Returns the bounce message content as text.
Returns the bounce message content as text.
Returns the time value for the given recipient Attribute.
Returns the time value for the given recipient Attribute.
Inherited From Inx_Api_BusinessObject
Inx_Api_BusinessObject::commitUpdate()
Inx_Api_BusinessObject::getId()
Inx_Api_BusinessObject::reload()
This category represents a bounce of auto responder type.
This category represents a bounce of auto responder type.
This category represents a hard bounce.
This category represents a hard bounce. A common reason for a hard bounce is an invalid email address.
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.
This category represents a bounce of spam type.
This category represents a bounce of spam type.
This category represents a bounce of unknown type.
This category represents a bounce of unknown type.
State for non existing (deleted) recipient.
State for non existing (deleted) recipient.
State for existent recipient.
State for existent recipient.
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
Documentation generated on Thu, 17 Sep 2015 14:27:21 +0200 by phpDocumentor 1.3.2