function MCAPI::campaignBounceMessages in Mailchimp 7

Same name and namespace in other branches

1. 6.2 MCAPI.class.php \MCAPI::campaignBounceMessages()

Retrieve the full bounce messages for the given campaign. Note that this can return very large amounts of data depending on how large the campaign was and how much cruft the bounce provider returned. Also, message over 30 days old are subject to being removed

Stats

@example mcapi_campaignBounceMessages.php

@returnf string date date/time the bounce was received and processed @returnf string email the email address that bounced @returnf string message the entire bounce message received

Parameters

string $cid the campaign id to pull bounces for (can be gathered using campaigns()):

integer $start optional for large data sets, the page number to start at - defaults to 1st page of data (page 0):

integer $limit optional for large data sets, the number of results to return - defaults to 25, upper limit set at 50:

string $since optional pull only messages since this time - use YYYY-MM-DD format in <strong>GMT</strong> (we only store the date, not the time):

Return value

array bounces the full bounce messages for this campaign

File

./MCAPI.class.php, line 679

Class

MCAPI

Code

function campaignBounceMessages($cid, $start = 0, $limit = 25, $since = NULL) {
  $params = array();
  $params["cid"] = $cid;
  $params["start"] = $start;
  $params["limit"] = $limit;
  $params["since"] = $since;
  return $this
    ->callServer("campaignBounceMessages", $params);
}