function MCAPI::campaignAbuseReports in Mailchimp 7

Same name and namespace in other branches

1. 5.2 MCAPI.class.php \MCAPI::campaignAbuseReports()
2. 5 MCAPI.class.php \MCAPI::campaignAbuseReports()
3. 6.2 MCAPI.class.php \MCAPI::campaignAbuseReports()
4. 6 MCAPI.class.php \MCAPI::campaignAbuseReports()

Get all email addresses that complained about a given campaign

Stats

@example mcapi_campaignAbuseReports.php

@returnf string date date/time the abuse report was received and processed @returnf string email the email address that reported abuse @returnf string type an internal type generally specifying the orginating mail provider - may not be useful outside of filling report views

Parameters

string $cid the campaign id to pull abuse reports 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 500, upper limit set at 1000:

string $since optional pull only messages since this time - use YYYY-MM-DD HH:II:SS format in <strong>GMT</strong>:

Return value

array reports the abuse reports for this campaign

File

./MCAPI.class.php, line 606

Class

MCAPI

Code

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