| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572 |
- <?php
- /**
- * Super-simple, minimum abstraction MailChimp API v3 wrapper
- * MailChimp API v3: http://developer.mailchimp.com
- * This wrapper: https://github.com/drewm/mailchimp-api
- *
- * @author Drew McLellan <drew.mclellan@gmail.com>
- * @version 2.4
- */
- class MailChimp
- {
- private $api_key;
- private $api_endpoint = 'https://<dc>.api.mailchimp.com/3.0';
- const TIMEOUT = 10;
- /* SSL Verification
- Read before disabling:
- http://snippets.webaware.com.au/howto/stop-turning-off-curlopt_ssl_verifypeer-and-fix-your-php-config/
- */
- public $verify_ssl = true;
- private $request_successful = false;
- private $last_error = '';
- private $last_response = array();
- private $last_request = array();
- /**
- * Create a new instance
- * @param string $api_key Your MailChimp API key
- * @param string $api_endpoint Optional custom API endpoint
- * @throws \Exception
- */
- public function __construct($api_key, $api_endpoint = null)
- {
- $this->api_key = $api_key;
- if ($api_endpoint === null) {
- if (strpos($this->api_key, '-') === false) {
- throw new Exception("Invalid MailChimp API key `{$api_key}` supplied.");
- }
- list(, $data_center) = explode('-', $this->api_key);
- $this->api_endpoint = str_replace('<dc>', $data_center, $this->api_endpoint);
- } else {
- $this->api_endpoint = $api_endpoint;
- }
- $this->last_response = array('headers' => null, 'body' => null);
- }
- /**
- * Create a new instance of a Batch request. Optionally with the ID of an existing batch.
- * @param string $batch_id Optional ID of an existing batch, if you need to check its status for example.
- * @return Batch New Batch object.
- */
- public function new_batch($batch_id = null)
- {
- return new Batch($this, $batch_id);
- }
- /**
- * @return string The url to the API endpoint
- */
- public function getApiEndpoint()
- {
- return $this->api_endpoint;
- }
- /**
- * Convert an email address into a 'subscriber hash' for identifying the subscriber in a method URL
- * @param string $email The subscriber's email address
- * @return string Hashed version of the input
- */
- public function subscriberHash($email)
- {
- return md5(strtolower($email));
- }
- /**
- * Was the last request successful?
- * @return bool True for success, false for failure
- */
- public function success()
- {
- return $this->request_successful;
- }
- /**
- * Get the last error returned by either the network transport, or by the API.
- * If something didn't work, this should contain the string describing the problem.
- * @return string|false describing the error
- */
- public function getLastError()
- {
- return $this->last_error ?: false;
- }
- /**
- * Get an array containing the HTTP headers and the body of the API response.
- * @return array Assoc array with keys 'headers' and 'body'
- */
- public function getLastResponse()
- {
- return $this->last_response;
- }
- /**
- * Get an array containing the HTTP headers and the body of the API request.
- * @return array Assoc array
- */
- public function getLastRequest()
- {
- return $this->last_request;
- }
- /**
- * Make an HTTP DELETE request - for deleting data
- * @param string $method URL of the API request method
- * @param array $args Assoc array of arguments (if any)
- * @param int $timeout Timeout limit for request in seconds
- * @return array|false Assoc array of API response, decoded from JSON
- */
- public function delete($method, $args = array(), $timeout = self::TIMEOUT)
- {
- return $this->makeRequest('delete', $method, $args, $timeout);
- }
- /**
- * Make an HTTP GET request - for retrieving data
- * @param string $method URL of the API request method
- * @param array $args Assoc array of arguments (usually your data)
- * @param int $timeout Timeout limit for request in seconds
- * @return array|false Assoc array of API response, decoded from JSON
- */
- public function get($method, $args = array(), $timeout = self::TIMEOUT)
- {
- return $this->makeRequest('get', $method, $args, $timeout);
- }
- /**
- * Make an HTTP PATCH request - for performing partial updates
- * @param string $method URL of the API request method
- * @param array $args Assoc array of arguments (usually your data)
- * @param int $timeout Timeout limit for request in seconds
- * @return array|false Assoc array of API response, decoded from JSON
- */
- public function patch($method, $args = array(), $timeout = self::TIMEOUT)
- {
- return $this->makeRequest('patch', $method, $args, $timeout);
- }
- /**
- * Make an HTTP POST request - for creating and updating items
- * @param string $method URL of the API request method
- * @param array $args Assoc array of arguments (usually your data)
- * @param int $timeout Timeout limit for request in seconds
- * @return array|false Assoc array of API response, decoded from JSON
- */
- public function post($method, $args = array(), $timeout = self::TIMEOUT)
- {
- return $this->makeRequest('post', $method, $args, $timeout);
- }
- /**
- * Make an HTTP PUT request - for creating new items
- * @param string $method URL of the API request method
- * @param array $args Assoc array of arguments (usually your data)
- * @param int $timeout Timeout limit for request in seconds
- * @return array|false Assoc array of API response, decoded from JSON
- */
- public function put($method, $args = array(), $timeout = self::TIMEOUT)
- {
- return $this->makeRequest('put', $method, $args, $timeout);
- }
- /**
- * Performs the underlying HTTP request. Not very exciting.
- * @param string $http_verb The HTTP verb to use: get, post, put, patch, delete
- * @param string $method The API method to be called
- * @param array $args Assoc array of parameters to be passed
- * @param int $timeout
- * @return array|false Assoc array of decoded result
- * @throws \Exception
- */
- private function makeRequest($http_verb, $method, $args = array(), $timeout = self::TIMEOUT)
- {
- if (!function_exists('curl_init') || !function_exists('curl_setopt')) {
- throw new Exception("cURL support is required, but can't be found.");
- }
- $url = $this->api_endpoint . '/' . $method;
- $response = $this->prepareStateForRequest($http_verb, $method, $url, $timeout);
- $ch = curl_init();
- curl_setopt($ch, CURLOPT_URL, $url);
- curl_setopt($ch, CURLOPT_HTTPHEADER, array(
- 'Accept: application/vnd.api+json',
- 'Content-Type: application/vnd.api+json',
- 'Authorization: apikey ' . $this->api_key
- ));
- curl_setopt($ch, CURLOPT_USERAGENT, 'DrewM/MailChimp-API/3.0 (github.com/drewm/mailchimp-api)');
- curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
- curl_setopt($ch, CURLOPT_VERBOSE, true);
- curl_setopt($ch, CURLOPT_HEADER, true);
- curl_setopt($ch, CURLOPT_TIMEOUT, $timeout);
- curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, $this->verify_ssl);
- curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_0);
- curl_setopt($ch, CURLOPT_ENCODING, '');
- curl_setopt($ch, CURLINFO_HEADER_OUT, true);
- switch ($http_verb) {
- case 'post':
- curl_setopt($ch, CURLOPT_POST, true);
- $this->attachRequestPayload($ch, $args);
- break;
- case 'get':
- $query = http_build_query($args, '', '&');
- curl_setopt($ch, CURLOPT_URL, $url . '?' . $query);
- break;
- case 'delete':
- curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
- break;
- case 'patch':
- curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
- $this->attachRequestPayload($ch, $args);
- break;
- case 'put':
- curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
- $this->attachRequestPayload($ch, $args);
- break;
- }
- $responseContent = curl_exec($ch);
- $response['headers'] = curl_getinfo($ch);
- $response = $this->setResponseState($response, $responseContent, $ch);
- $formattedResponse = $this->formatResponse($response);
- curl_close($ch);
- $this->determineSuccess($response, $formattedResponse, $timeout);
- return $formattedResponse;
- }
- /**
- * @param string $http_verb
- * @param string $method
- * @param string $url
- * @param integer $timeout
- */
- private function prepareStateForRequest($http_verb, $method, $url, $timeout)
- {
- $this->last_error = '';
- $this->request_successful = false;
- $this->last_response = array(
- 'headers' => null, // array of details from curl_getinfo()
- 'httpHeaders' => null, // array of HTTP headers
- 'body' => null // content of the response
- );
- $this->last_request = array(
- 'method' => $http_verb,
- 'path' => $method,
- 'url' => $url,
- 'body' => '',
- 'timeout' => $timeout,
- );
- return $this->last_response;
- }
- /**
- * Get the HTTP headers as an array of header-name => header-value pairs.
- *
- * The "Link" header is parsed into an associative array based on the
- * rel names it contains. The original value is available under
- * the "_raw" key.
- *
- * @param string $headersAsString
- * @return array
- */
- private function getHeadersAsArray($headersAsString)
- {
- $headers = array();
- foreach (explode("\r\n", $headersAsString) as $i => $line) {
- if ($i === 0) { // HTTP code
- continue;
- }
- $line = trim($line);
- if (empty($line)) {
- continue;
- }
- list($key, $value) = explode(': ', $line);
- if ($key == 'Link') {
- $value = array_merge(
- array('_raw' => $value),
- $this->getLinkHeaderAsArray($value)
- );
- }
- $headers[$key] = $value;
- }
- return $headers;
- }
- /**
- * Extract all rel => URL pairs from the provided Link header value
- *
- * Mailchimp only implements the URI reference and relation type from
- * RFC 5988, so the value of the header is something like this:
- *
- * 'https://us13.api.mailchimp.com/schema/3.0/Lists/Instance.json; rel="describedBy", <https://us13.admin.mailchimp.com/lists/members/?id=XXXX>; rel="dashboard"'
- *
- * @param string $linkHeaderAsString
- * @return array
- */
- private function getLinkHeaderAsArray($linkHeaderAsString)
- {
- $urls = array();
- if (preg_match_all('/<(.*?)>\s*;\s*rel="(.*?)"\s*/', $linkHeaderAsString, $matches)) {
- foreach ($matches[2] as $i => $relName) {
- $urls[$relName] = $matches[1][$i];
- }
- }
- return $urls;
- }
- /**
- * Encode the data and attach it to the request
- * @param resource $ch cURL session handle, used by reference
- * @param array $data Assoc array of data to attach
- */
- private function attachRequestPayload(&$ch, $data)
- {
- $encoded = json_encode($data);
- $this->last_request['body'] = $encoded;
- curl_setopt($ch, CURLOPT_POSTFIELDS, $encoded);
- }
- /**
- * Decode the response and format any error messages for debugging
- * @param array $response The response from the curl request
- * @return array|false The JSON decoded into an array
- */
- private function formatResponse($response)
- {
- $this->last_response = $response;
- if (!empty($response['body'])) {
- return json_decode($response['body'], true);
- }
- return false;
- }
- /**
- * Do post-request formatting and setting state from the response
- * @param array $response The response from the curl request
- * @param string $responseContent The body of the response from the curl request
- * * @return array The modified response
- */
- private function setResponseState($response, $responseContent, $ch)
- {
- if ($responseContent === false) {
- $this->last_error = curl_error($ch);
- } else {
- $headerSize = $response['headers']['header_size'];
- $response['httpHeaders'] = $this->getHeadersAsArray(substr($responseContent, 0, $headerSize));
- $response['body'] = substr($responseContent, $headerSize);
- if (isset($response['headers']['request_header'])) {
- $this->last_request['headers'] = $response['headers']['request_header'];
- }
- }
- return $response;
- }
- /**
- * Check if the response was successful or a failure. If it failed, store the error.
- * @param array $response The response from the curl request
- * @param array|false $formattedResponse The response body payload from the curl request
- * @param int $timeout The timeout supplied to the curl request.
- * @return bool If the request was successful
- */
- private function determineSuccess($response, $formattedResponse, $timeout)
- {
- $status = $this->findHTTPStatus($response, $formattedResponse);
- if ($status >= 200 && $status <= 299) {
- $this->request_successful = true;
- return true;
- }
- if (isset($formattedResponse['detail'])) {
- $this->last_error = sprintf('%d: %s', $formattedResponse['status'], $formattedResponse['detail']);
- return false;
- }
- if( $timeout > 0 && $response['headers'] && $response['headers']['total_time'] >= $timeout ) {
- $this->last_error = sprintf('Request timed out after %f seconds.', $response['headers']['total_time'] );
- return false;
- }
- $this->last_error = 'Unknown error, call getLastResponse() to find out what happened.';
- return false;
- }
- /**
- * Find the HTTP status code from the headers or API response body
- * @param array $response The response from the curl request
- * @param array|false $formattedResponse The response body payload from the curl request
- * @return int HTTP status code
- */
- private function findHTTPStatus($response, $formattedResponse)
- {
- if (!empty($response['headers']) && isset($response['headers']['http_code'])) {
- return (int) $response['headers']['http_code'];
- }
- if (!empty($response['body']) && isset($formattedResponse['status'])) {
- return (int) $formattedResponse['status'];
- }
- return 418;
- }
- /**
- * Get all the mailing list. Takes care of the request limit (50 records) from the MC API.
- * @param array $args Assoc array of arguments
- * @return array of all the lists with the MC account.
- */
- public function getLists( $args = array() ){
- $defaults = array(
- 'count' => 50,
- 'offset' => 0,
- 'sort_field' => 'date_created',
- 'sort_dir' => 'ASC',
- 'fields' => 'lists.name,lists.id,total_items'
- );
- $r = array_merge( $defaults, $args );
- $result = $this->get( 'lists', $r );
- $lists = array();
- if ( isset( $result[ 'lists' ] ) ) {
- $lists = $result[ 'lists' ];
- if ( count( $lists ) < $result[ 'total_items' ] ) {
- for ( $offset = 50; $offset < $result[ 'total_items' ]; $offset += 50 ) {
- $r[ 'offset' ] = $offset;
- $new_result = $this->get( 'lists', $r );
- $lists = array_merge( $lists, $new_result[ 'lists' ] );
- }
- }
- }
- return $lists;
- }
- /**
- * Get the list of interest groupings for a given list, including the label, form information, and included groups for each
- * @param string $list_id
- * @return array of structs of the interest groupings for the list
- */
- public function interestGroupings( $list_id ) {
- if ( ! $list_id ) {
- return;
- }
- $groups = array();
- $results = $this->get(
- 'lists/' . $list_id . '/interest-categories',
- array(
- 'fields' => 'categories.id,categories.title,total_items'
- )
- );
- if ( $results[ 'total_items' ] > 0 ) {
- foreach ( $results[ 'categories' ] as $category ) {
- $subgroups = $this->get(
- 'lists/' . $list_id . '/interest-categories/' . $category[ 'id' ] . '/interests',
- array(
- 'fields' => 'interests.id,interests.name,total_items'
- )
- );
- if ( $subgroups[ 'total_items' ] > 0 ) {
- $category[ 'groups' ] = $subgroups[ 'interests' ];
- }
- $groups[] = $category;
- }
- }
- return $groups;
- }
- /**
- * Subscribe a member to a list. It will automatically update member if exists.
- * @param string $list_id
- * @param array $data
- * @return array
- */
- public function subscribe( $list_id, $data ){
- if ( ! isset( $list_id ) || ! isset( $data[ 'email' ] ) ) {
- return;
- }
- $member = $this->get_member( $list_id, $data[ 'email' ] );
- if ( ! $this->getLastError() && 'unsubscribed' == $member[ 'status' ] ) {
- // Re-subscribe member if their status is `unsubscribed`.
- $data[ 'status' ] = 'pending';
- }
- $args = array(
- 'email_address' => $data[ 'email' ],
- 'status_if_new' => $data[ 'double_optin' ] ? 'pending' : 'subscribed',
- 'status' => isset( $data[ 'status' ] ) ? $data[ 'status' ] : 'subscribed',
- 'email_type' => 'html',
- 'merge_fields' => array(
- 'FNAME' => ! empty( $data[ 'FNAME' ] ) ? $data[ 'FNAME' ] : '',
- 'LNAME' => ! empty( $data[ 'LNAME' ] ) ? $data[ 'LNAME' ] : ''
- ),
- );
- if ( isset( $data[ 'groups' ] ) ) {
- $args[ 'interests' ] = (object) $data[ 'groups' ];
- }
- $email_hash = $this->subscriberHash( $data[ 'email' ] );
- $results = $this->put( 'lists/' . $list_id . '/members/' . $email_hash, $args );
- return $results;
- }
- /**
- * Get information about a specific list member.
- * @param string $list_id
- * @param string $email
- * @return array
- */
- public function get_member( $list_id, $email ){
- if ( ! $email ) {
- return;
- }
- $email_hash = $this->subscriberHash( $email );
- $result = $this->get( 'lists/' . $list_id . '/members/' . $email_hash );
- return $result;
- }
- }
|