Skip to content

Mandrill_Exports

Jump to bottom
Mathieu Nayrolles edited this page Jan 20, 2016 · 1 revision

Mandrill_Exports

  • Class name: Mandrill_Exports
  • Namespace:

Methods

__construct

mixed Mandrill_Exports::__construct(\Mandrill $master)
  • Visibility: public

Arguments

info

\struct Mandrill_Exports::info(string $id)

Returns information about an export job. If the export job's state is 'complete', the returned data will include a URL you can use to fetch the results. Every export job produces a zip archive, but the format of the archive is distinct for each job type. The api calls that initiate exports include more details about the output format for that job type.

  • Visibility: public

Arguments

  • $id string - <p>an export job identifier</p>

getList

array Mandrill_Exports::getList()

Returns a list of your exports.

  • Visibility: public

rejects

\struct Mandrill_Exports::rejects(string $notify_email)

Begins an export of your rejection blacklist. The blacklist will be exported to a zip archive containing a single file named rejects.csv that includes the following fields: email, reason, detail, created_at, expires_at, last_event_at, expires_at.

  • Visibility: public

Arguments

  • $notify_email string - <p>an optional email address to notify when the export job has finished.</p>

whitelist

\struct Mandrill_Exports::whitelist(string $notify_email)

Begins an export of your rejection whitelist. The whitelist will be exported to a zip archive containing a single file named whitelist.csv that includes the following fields: email, detail, created_at.

  • Visibility: public

Arguments

  • $notify_email string - <p>an optional email address to notify when the export job has finished.</p>

activity

\struct Mandrill_Exports::activity(string $notify_email, string $date_from, string $date_to, array $tags, array $senders, array $states, array $api_keys)

Begins an export of your activity history. The activity will be exported to a zip archive containing a single file named activity.csv in the same format as you would be able to export from your account's activity view. It includes the following fields: Date, Email Address, Sender, Subject, Status, Tags, Opens, Clicks, Bounce Detail. If you have configured any custom metadata fields, they will be included in the exported data.

  • Visibility: public

Arguments

  • $notify_email string - <p>an optional email address to notify when the export job has finished</p>
  • $date_from string - <p>start date as a UTC string in YYYY-MM-DD HH:MM:SS format</p>
  • $date_to string - <p>end date as a UTC string in YYYY-MM-DD HH:MM:SS format</p>
  • $tags array - <p>an array of tag names to narrow the export to; will match messages that contain ANY of the tags</p> <ul> <li>tags[] string a tag name</li> </ul>
  • $senders array - <p>an array of senders to narrow the export to</p> <ul> <li>senders[] string a sender address</li> </ul>
  • $states array - <p>an array of states to narrow the export to; messages with ANY of the states will be included</p> <ul> <li>states[] string a message state</li> </ul>
  • $api_keys array - <p>an array of api keys to narrow the export to; messsagse sent with ANY of the keys will be included</p> <ul> <li>api_keys[] string an API key associated with your account</li> </ul>
Clone this wiki locally