reportGetBounces
public static array reportGetBounces(string token, string emailID, integer pageNumber, integer pageSize,string Filter, string orderBy,string sortOrder)
Get the email addresses which bounced in a given campaign,using the paging limits, ordered by the email or date of the bounced record.
Section
Reports Related Methods

Parameters
string tokenA valid token for your account. To generate a token, use the login method.
string emailIDThe email campaign ID for which the bounces are to be fetched. To get the email campaign ID, use the reportGet method.
integer pageNumberFetch results from the given page number.
integer pageSizeNumber of results per page.
string FilterEither requires Hard or soft Bounce
string orderBySort the results based on "email" or "date".
string sortOrderThe sort order (asc / desc)

Returns
arrayReturns an array with the results.

Return Structure
integer sequenceThe sequence number of the record
string emailThe bounced email address
string nameName of the contact
string typeType of bounce. Can be either Soft or Hard bounce.


Examples
download example code
xmlrpc_reportGetBounces.php


  1. <?php
  2. /**
  3. This Example shows how to authenticate a user using XML-RPC.
  4. Note that we are using the PEAR XML-RPC client and recommend others do as well.
  5. **/
  6. require_once 'XML/RPC2/Client.php';
  7. require_once 'inc/config.php';
  8. $client = XML_RPC2_Client::create($apiURL);
  9. $token = $client->login($apiLogin, $apiPassword);
  10.  
  11. /**
  12. Fetch the latest campaign, so we can retrieve the email campaign ID.
  13. **/
  14. $campaignList = $client->reportGet($token, "", 1, 1, "", "");
  15. $campaignID = $campaignList[0]['id'];
  16.  
  17. $bounceList = $client->reportGetBounces($token, $campaignID, 1, 100, "","","");
  18.  
  19. foreach($bounceList as $rec){
  20.     echo $rec['sequence'] . "] Email: " . $rec['email'];
  21.     echo " Name: " . $rec['name'];
  22.     echo " Bounce Type: " . $rec['type'] . "<br />";
  23. }
  24.  
  25. ?>