readBounces

The readBounces function attempts to return bounce data that matches the passed in filter.

Results

The readBounces function may return 1 or many bounce objects. See the documentation on the bounceObject for a list of the data fields that could potentially be returned.

Syntax

bounceObject[] bounces = bApi.readBounces(filter bounceFilter, pageNumber);

Parameters

Name Type Required Comments
filter bounceFilter Yes The filter used to return specific bounce data.
pageNumber int Yes Retrieves the next “batch” of objects as the value specified increases from 1. In order to obtain an entire set of objects for a given call, you should increase the number value assigned to pageNumber until no more objects are returned.