Interface Inx_Api_Bounce_BounceManager

Description

The Inx_Api_Bounce_BounceManager can be used to retrieve bounces.

The Inx_Api_Bounce_BounceManager can be used to retrieve bounces. There are different methods for the retrieval of bounces, for example you can retrieve bounces by date. The following example returns an Inx_Api_BOResultSet containing all bounces in the system:

 $oBounceManager = $oSession->getBounceManager();
 $oBOResultSet = $oBounceManager->selectAll();

 for( $i = 0; $i < $oBOResultSet->size(); $i++ )
 {
 	$oBounce = $oBOResultSet->get( $i );
 	echo $oBounce->getSubject()."<br>";
 }

 $oBOResultSet->close();
Note: The select*() methods retrieve no recipient information but the id. If you wish to retrieve the recipient state or some of the recipients attributes, use the select*(..., Inx_Api_Recipient_RecipientContext, Inx_Api_Recipient_Attribute[]) methods instead. Note: The usage of bounces requires the api user right: Inx_Api_UserRights::ERRORMAIL_FEATURE_USE

For more information on bounces, see the Inx_Api_Bounce_Bounce documentation.

  • version: $Revision: 9553 $ $Date: 2008-01-04 11:28:41 +0200 (Pn, 04 Sau 2008) $ $Author: vladas $
  • see: Inx_Api_Bounce_Bounce
  • since: API 1.4.3

Located in /Api/Bounce/BounceManager.php (line 39)

Inx_Api_BOManager
   |
   --Inx_Api_Bounce_BounceManager
Method Summary
an selectAfter (string $searchDate, [Inx_Api_Recipient_RecipientContext $oRc = null], [ $aAttrs = null])
an selectAllBounces ([Inx_Api_Recipient_RecipientContext $oRc = null], [ $aAttrs = null])
an selectBefore (string $searchDate, [Inx_Api_Recipient_RecipientContext $oRc = null], [ $aAttrs = null])
an selectBetween (string $startDate, string $stopDate, [Inx_Api_Recipient_RecipientContext $oRc = null], [ $aAttrs = null])
an selectByListId (int $listId, [Inx_Api_Recipient_RecipientContext $oRc = null], [ $aAttrs = null])
an selectByMailingId (int $mailingId, [Inx_Api_Recipient_RecipientContext $oRc = null], [ $aAttrs = null])
Methods
createQuery (line 186)

Creates a query object which allows to retrieve bounces using a fluent interface. filter the bounces by the following criteria:

  • mailing ID(s)
  • list ID(s)
  • category ID(s)
  • start date
  • end date
All filters can be freely combined. keeps the syntax as concise as possible.

Creates a query object which allows to retrieve bounces using a fluent interface. Using this object you can filter the bounces by the following criteria:

  • mailing ID(s)
  • list ID(s)
  • category ID(s)
  • start date
  • end date
All filters can be freely combined. This allows the creation of complex queries while the fluent interface keeps the syntax as concise as possible. This method accepts two parameters to select additional recipient attributes with the bounces.

  • return: a BounceQuery object which allows to retrieve bounces using a fluent interface.
  • throws: Inx_Api_IllegalArgumentException an IllegalArgumentException if the Attribute array contains null values. Note that a null value for the array itself is allowed.
  • since: API 1.12.1
  • access: public
Inx_Api_Bounce_BounceQuery createQuery ([Inx_Api_Recipient_RecipientContext $oRc = null], [ $aAttrs = null])
  • Inx_Api_Recipient_RecipientContext $oRc: the Inx_Api_Recipient_RecipientContext that shall be used to retrieve recipient attributes. See Inx_Api_Session->createRecipientContext().
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that shall be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData.
selectAfter (line 78)

Returns a result set containing all bounces which occurred after the specified date.

Returns a result set containing all bounces which occurred after the specified date. If the Inx_Api_Recipient_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved bounces will contain information about the recipient state and the specified recipient attributes.
Warning: A fatal error may occur if the Attribute array contains null values. Note that a null value for the array itself is allowed.

  • return: Inx_Api_BOResultSet containing all bounces matching the condition.
  • since: API 1.6.1
  • access: public
an selectAfter (string $searchDate, [Inx_Api_Recipient_RecipientContext $oRc = null], [ $aAttrs = null])
  • string $searchDate: all bounces after this date will be selected. The date has to be formatted as ISO 8601.
  • Inx_Api_Recipient_RecipientContext $oRc: the Inx_Api_Recipient_RecipientContext. See Inx_Api_Session->createRecipientContext().
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData.
selectAllBounces (line 159)

Returns a result set containing all bounces.

Returns a result set containing all bounces. If there are no bounces, an empty result set will be returned. If the Inx_Api_Recipient_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved bounces will contain information about the recipient state and the specified recipient attributes.
Warning: A fatal error may occur if the Attribute array contains null values. Note that a null value for the array itself is allowed.

  • return: Inx_Api_BOResultSet containing all bounces matching the condition.
  • since: API 1.6.1
  • access: public
an selectAllBounces ([Inx_Api_Recipient_RecipientContext $oRc = null], [ $aAttrs = null])
  • Inx_Api_Recipient_RecipientContext $oRc: the Inx_Api_Recipient_RecipientContext. See Inx_Api_Session->createRecipientContext().
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData.
selectBefore (line 58)

Returns a result set containing all bounces which occurred before the specified date.

Returns a result set containing all bounces which occurred before the specified date. If the Inx_Api_Recipient_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved bounces will contain information about the recipient state and the specified recipient attributes.
Warning: A fatal error may occur if the Attribute array contains null values. Note that a null value for the array itself is allowed.

  • return: Inx_Api_BOResultSet containing all bounces matching the condition.
  • since: API 1.6.1
  • access: public
an selectBefore (string $searchDate, [Inx_Api_Recipient_RecipientContext $oRc = null], [ $aAttrs = null])
  • string $searchDate: all bounces before this date will be selected. The date has to be formatted as ISO 8601.
  • Inx_Api_Recipient_RecipientContext $oRc: the Inx_Api_Recipient_RecipientContext. See Inx_Api_Session->createRecipientContext().
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData.
selectBetween (line 99)

Returns a result set containing all bounces which occurred between the specified dates.

Returns a result set containing all bounces which occurred between the specified dates. If the Inx_Api_Recipient_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved bounces will contain information about the recipient state and the specified recipient attributes.
Warning: A fatal error may occur if the Attribute array contains null values. Note that a null value for the array itself is allowed.

  • return: Inx_Api_BOResultSet containing all bounces matching the condition.
  • since: API 1.6.1
  • access: public
an selectBetween (string $startDate, string $stopDate, [Inx_Api_Recipient_RecipientContext $oRc = null], [ $aAttrs = null])
  • string $startDate: the start date. The date has to be formatted as ISO 8601.
  • string $stopDate: the stop date. The date has to be formatted as ISO 8601.
  • Inx_Api_Recipient_RecipientContext $oRc: the Inx_Api_Recipient_RecipientContext. See Inx_Api_Session->createRecipientContext().
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData.
selectByListId (line 140)

Returns a result set containing all bounces regarding the specified list.

Returns a result set containing all bounces regarding the specified list. If there are no bounces, an empty result set will be returned. If the Inx_Api_Recipient_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved bounces will contain information about the recipient state and the specified recipient attributes.
Warning: A fatal error may occur if the Attribute array contains null values. Note that a null value for the array itself is allowed.

  • return: Inx_Api_BOResultSet containing all bounces matching the condition.
  • since: API 1.6.1
  • access: public
an selectByListId (int $listId, [Inx_Api_Recipient_RecipientContext $oRc = null], [ $aAttrs = null])
  • int $listId: the id of the list.
  • Inx_Api_Recipient_RecipientContext $oRc: the Inx_Api_Recipient_RecipientContext. See Inx_Api_Session->createRecipientContext().
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData.
selectByMailingId (line 119)

Returns a result set containing all bounces regarding the specified mailing.

Returns a result set containing all bounces regarding the specified mailing. If there are no bounces, an empty result set will be returned. If the Inx_Api_Recipient_RecipientContext is not null and the Inx_Api_Recipient_Attribute array contains at least one element, the retrieved bounces will contain information about the recipient state and the specified recipient attributes.
Warning: A fatal error may occur if the Attribute array contains null values. Note that a null value for the array itself is allowed.

  • return: Inx_Api_BOResultSet containing all bounces matching the condition.
  • since: API 1.6.1
  • access: public
an selectByMailingId (int $mailingId, [Inx_Api_Recipient_RecipientContext $oRc = null], [ $aAttrs = null])
  • int $mailingId: the id of the mailing.
  • Inx_Api_Recipient_RecipientContext $oRc: the Inx_Api_Recipient_RecipientContext. See Inx_Api_Session->createRecipientContext().
  • array $aAttrs: an array of Inx_Api_Recipient_Attributes that will be fetched for later retrieval. See Inx_Api_Recipient_RecipientMetaData.

Inherited Methods

Inherited From Inx_Api_BOManager

Inx_Api_BOManager::get()
Inx_Api_BOManager::remove()
Inx_Api_BOManager::selectAll()

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