Interface Inx_Api_Bounce_BounceQuery

Description

  1. BounceQuery
provides a fluent interface for retrieving bounces. filter bounces:
  • mailing ID(s)
  • list ID(s)
  • category ID(s)
  • start date
  • end date
Each filter is assigned by calling the corresponding method. an
  1. int[]
. keeps the syntax as concise as possible.

  1. BounceQuery
provides a fluent interface for retrieving bounces. The following criteria can be used to filter bounces:
  • mailing ID(s)
  • list ID(s)
  • category ID(s)
  • start date
  • end date
Each filter is assigned by calling the corresponding method. All filters can be freely combined. IDs can be given as an
  1. int[]
. This allows the creation of complex queries while the fluent interface keeps the syntax as concise as possible. <strong>Note:</strong> Each filter may only be applied once. For example, it is not possible to create a query that retrieves all bounces of two time periods (e.g. all bounces performed during February and during September). However, applying a filter twice (i.e. calling the corresponding method twice) is not an error. The last application (method call) of the filter will always overwrite all previous applications.

An empty Inx_Api_Bounce_BounceQuery object can be obtained from the Inx_Api_Bounce_BounceManager.

The following snippet shows how to construct and execute a query for two particular lists with bounce category hard bounce and soft bounce:

 $oBounceManager = $oSession->getBounceManager();
 $oBounceQuery = $oBounceManager->createQuery();

 $aListIds = array(3, 5);
 $aCategoryIds = array(Inx_Api_Bounce_Bounce::CATEGORY_HARD_BOUNCE, Inx_Api_Bounce_Bounce::CATEGORY_AUTO_RESPONDER_BOUNCE);

 $oBOResultSet = $oBounceQuery->listIds($aListIds)->categoryIds($aCategoryIds)->executeQuery();

 foreach( $oBOResultSet as $oBounce )
	{
		echo $oBounce->getSender()."<br>";
	}

 $oBOResultSet->close();

Located in /Api/Bounce/BounceQuery.php (line 45)


	
			
Method Summary
Methods
after (line 96)

Assigns an after filter (start date), overwriting any existing after filters, including those imposed by between filters.

Assigns an after filter (start date), overwriting any existing after filters, including those imposed by between filters. The result will only contain bounces that happened at or after the given date.

  • return: this query.
  • access: public
Inx_Api_Bounce_BounceQuery after (string $sDate)
  • string $sDate: the date by which the result shall be filtered, inclusively. The date has to be specified as ISO-8601 formatted datetime string.
before (line 85)

Assigns an before filter (end date), overwriting any existing before filters, including those imposed by between filters.

Assigns an before filter (end date), overwriting any existing before filters, including those imposed by between filters. The result will only contain bounces that happened before or at the given date.

  • return: this query.
  • access: public
Inx_Api_Bounce_BounceQuery before (string $sDate)
  • string $sDate: the date by which the result shall be filtered, inclusively. The date has to be specified as ISO-8601 formatted datetime string.
between (line 109)

Assigns a between filter (start and end date), overwriting any existing before, after and between filters. result will only contain bounces performed after or at the given start date and before or at the given end date.

Assigns a between filter (start and end date), overwriting any existing before, after and between filters. The result will only contain bounces performed after or at the given start date and before or at the given end date.

  • return: this query.
  • access: public
Inx_Api_Bounce_BounceQuery between (string $sStart, string $sEnd)
  • string $sStart: the start date by which the result shall be filtered, inclusively. The date has to be specified as ISO-8601 formatted datetime string.
  • string $sEnd: the end date by which the result shall be filtered, inclusively. The date has to be specified as ISO-8601 formatted datetime string.
categoryIds (line 75)

Assigns a category filter for one or several categories, overwriting any existing category filter. will only contain bounces which are received as a reply to mailings from the given categories.

Assigns a category filter for one or several categories, overwriting any existing category filter. The result will only contain bounces which are received as a reply to mailings from the given categories. For invalid category IDs an Inx_Api_IllegalArgumentException will be thrown.

  • return: this query
  • throws: Inx_Api_IllegalArgumentException if a category ID is invalid.
  • access: public
Inx_Api_Bounce_BounceQuery categoryIds ( $aCategoryIds)
  • array $aCategoryIds: the IDs of the categories by which the result shall be filtered.
executeQuery (line 118)

Executes the query, applying all filters and returning the resulting

  1. BOResultSet
.

Executes the query, applying all filters and returning the resulting

  1. BOResultSet
.

  • return: a BounceDelegateResultSet object that contains the bounce data retrieved by this query.
  • throws: Inx_Api_SecurityException if the user does not have permission to access the errormail agent
  • access: public
listIds (line 64)

Assigns a list filter for one or several lists, overwriting any existing list filter. bounces which were received in reply to mailings from the given lists.

Assigns a list filter for one or several lists, overwriting any existing list filter. The result will only contain bounces which were received in reply to mailings from the given lists. Invalid list IDs will be ignored.

  • return: this query
  • access: public
Inx_Api_Bounce_BounceQuery listIds ( $aListIds)
  • array $aListIds: the IDs of the lists by which the result shall be filtered.
mailingIds (line 54)

Assigns a mailing filter for one or several mailings, overwriting any existing mailing filters. contain bounces which were received in reply to these mailings.

Assigns a mailing filter for one or several mailings, overwriting any existing mailing filters. The result will only contain bounces which were received in reply to these mailings. Invalid mailing IDs will be ignored.

  • return: this query.
  • access: public
Inx_Api_Bounce_BounceQuery mailingIds ( $aMailingIds)
  • array $aMailingIds: the IDs of the mailings by which the result shall be filtered.

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