campaignmonitor.class.inc in Campaign Monitor 7
Implementation of the CampaignMonitor class.
A wrapper class for Campaign Monitor v3 API. It's implemented as a Singleton class and instances are created using the account variables and the static function getConnector(). An example:.
<?php $account = variable_get('campaignmonitor_account', array()); $cm = CampaignMonitor::getConnector($account['api_key'], $account['client_id']); ?>
If the class encounters any error in the communication with the Campaign Monitor servers, then the last error can be extracted with getLatestError() function, for example:
<?php if (!$cm->unsubscribe($listId, $email)) { $error = $cm->getLatestError(); form_set_error('', $error['message']); } ?>
This class is written by Jesper Kristensen (cableman@linuxdev.dk).
File
lib/campaignmonitor.class.incView source
<?php
/**
* @file
* Implementation of the CampaignMonitor class.
*
* A wrapper class for Campaign Monitor v3 API. It's implemented as a Singleton
* class and instances are created using the account variables and the static
* function getConnector(). An example:.
*
* <?php
* $account = variable_get('campaignmonitor_account', array());
* $cm = CampaignMonitor::getConnector($account['api_key'],
* $account['client_id']);
* ?>
*
* If the class encounters any error in the communication with the Campaign
* Monitor servers, then the last error can be extracted with getLatestError()
* function, for example:
*
* <?php
* if (!$cm->unsubscribe($listId, $email)) {
* $error = $cm->getLatestError();
* form_set_error('', $error['message']);
* }
* ?>
*
* This class is written by Jesper Kristensen (cableman@linuxdev.dk).
*/
/**
* Implementation of the CampaignMonitor class.
*/
class CampaignMonitor {
// Used to load the different library parts of the API.
const FILE_CLIENT = 'csrest_clients.php';
const FILE_LIST = 'csrest_lists.php';
const FILE_SUBSCRIBERS = 'csrest_subscribers.php';
/**
* API key.
*
* @var string
*/
protected $apiKey;
/**
* Client ID.
*
* @var string
*/
protected $clientId;
/**
* Errors array.
*
* @var array
*/
private $logErrors = FALSE;
/**
* Errors array.
*
* @var array
*/
private $errors = [];
/**
* Library path.
*
* @var string
*/
private $libraryPath = FALSE;
/**
* Cache array for lists.
*
* @var array
*/
private $lists = [];
/**
* Cache array for list stats.
*
* @var array
*/
private $listStats = [];
/**
* Cache array for campaigns.
*
* @var array
*/
private $campaigns = [];
/**
* Cache array for subscribers.
*
* @var array
*/
private $subscribers = [];
/**
* Holds the object instance (part of the singleton pattern).
*
* @var CampaignMonitor
*/
private static $instance;
/**
* Private class constructor.
*
* Prevents creation of this class directly.
* Use the static function CampaignMonitor::GetConnector().
*
* @param string|bool $api_key
* (optional) The api key.
* @param string|bool $client_id
* (optional) The client ID.
*/
private function __construct($api_key = FALSE, $client_id = FALSE) {
// Get account information.
$account = variable_get('campaignmonitor_account', []);
// Get API key/client ID if they are defined.
$this->apiKey = $api_key ? $api_key : (isset($account['api_key']) ? $account['api_key'] : FALSE);
$this->clientId = $client_id ? $client_id : (isset($account['client_id']) ? $account['client_id'] : FALSE);
// Trying to find the Campaign Monitor library.
$this
->getLibraryPath();
// Enable logging.
$setting = variable_get('campaignmonitor_general', []);
if (isset($setting['logging'])) {
$this->logErrors = $setting['logging'];
}
}
/**
* Add an error to the local stack and call watchdog, if logging is enabled.
*
* @param string $type
* Drupal watchdog const. error type.
* @param string $message
* The error message.
* @param int $code
* Normally the HTTP response code.
*/
private function addError($type, $message, $code = -1) {
$this->errors[] = [
'type' => $type,
'code' => $code,
'message' => t('%message', [
'%message' => $message,
]),
];
if ($this->logErrors) {
$msg = t('Failed with code: @code and message: @msg', [
'@code' => $code,
'@msg' => $message,
]);
watchdog('campaignmonitor', $msg, NULL, $type);
}
}
/**
* Tries to find the path of the Campaign Monitor API library path.
*
* If the library is not found an error message is set and FALSE is returned.
*
* @return string|bool
* Either a string containing the library path or FALSE if the library is
* not found.
*/
public function getLibraryPath() {
if (!$this->libraryPath) {
$setting = variable_get('campaignmonitor_general', []);
// Uses library module to detect the library.
if (module_exists('libraries')) {
$libraries = libraries_get_libraries();
if (isset($libraries['campaignmonitor'])) {
$this->libraryPath = $libraries['campaignmonitor'];
}
}
// If the library was not found, try to use the defined path.
if (!$this->libraryPath) {
if (isset($setting['library_path']) && !empty($setting['library_path'])) {
// User has defined the library path.
if (file_exists($setting['library_path'])) {
$this->libraryPath = $setting['library_path'];
}
}
}
}
if (!$this->libraryPath) {
drupal_set_message(t('The Campaign Monitor PHP integration library was not detected, please see the README for information about installing the library.'), 'error', FALSE);
}
return $this->libraryPath;
}
/**
* Helper function that loads the part of the API.
*
* As defined in the $file variable. This function is mostly used by
* create[xxx]Obj functions below.
*
* @param string $file
* The name of the API file to include.
*
* @return bool
* TRUE on success, FALSE otherwise.
*/
private function libraryLoad($file) {
if ($this
->getLibraryPath()) {
@(require_once $this->libraryPath . '/' . $file);
return TRUE;
}
$this
->addError(WATCHDOG_ERROR, t('Unable to load client library.'));
return FALSE;
}
/**
* Create API client object.
*
* @return CS_REST_Clients|bool
* The Campaign Monitor client object or FALSE on failure.
*/
private function createClientObj() {
if ($this
->libraryLoad(self::FILE_CLIENT)) {
return new CS_REST_Clients($this->clientId, $this->apiKey);
}
$this
->addError(WATCHDOG_ERROR, t('Failed to locate the client library.'));
return FALSE;
}
/**
* Create API list object.
*
* @param string $list_id
* The Campaign Monitor list ID.
*
* @return CS_REST_Lists|bool
* The Campaign Monitor list object or FALSE on failure.
*/
private function createListObj($list_id) {
if ($this
->libraryLoad(self::FILE_LIST)) {
return new CS_REST_Lists($list_id, $this->apiKey);
}
$this
->addError(WATCHDOG_ERROR, t('Failed to locate the list library.'));
return FALSE;
}
/**
* Create API subscribers object.
*
* @param string $list_id
* The Campaign Monitor list ID.
*
* @return CS_REST_Subscribers|bool
* The Campaign Monitor subscriber object or FALSE on failure.
*/
private function createSubscriberObj($list_id) {
if ($this
->libraryLoad(self::FILE_SUBSCRIBERS)) {
return new CS_REST_Subscribers($list_id, $this->apiKey);
}
$this
->addError(WATCHDOG_ERROR, t('Failed to locate the subscribers library.'));
return FALSE;
}
/**
* Create a UNIX timestamp based on the cache timeout.
*
* @return string
* A UNIX timestamp.
*/
private function getCacheTimeout() {
$options = variable_get('campaignmonitor_general', []);
return time() + (isset($options['cache_timeout']) ? $options['cache_timeout'] : '360');
}
/**
* Implements a singleton pattern that returns an instance of this object.
*
* The function requires Campaign Monitor account keys to create the
* connection. These keys can be found at the Campaign Monitor homepage
* and should be entered in the administration interface. The object can
* then be created like this:
*
* <?php
* $account = variable_get('campaignmonitor_account', array());
* $cm = CampaignMonitor::getConnector($account['api_key'],
* $account['client_id']);
* ?>
*
* @param string|bool $api_key
* The Campaign Monitor API key.
* @param string|bool $client_key
* The Campaign Monitor client key.
*
* @return CampaignMonitor
* The CampaignMonitor singleton object.
*/
public static function getConnector($api_key = FALSE, $client_key = FALSE) {
if ($api_key && $client_key || !isset(self::$instance)) {
$class = __CLASS__;
self::$instance = new $class($api_key, $client_key);
}
return self::$instance;
}
/**
* Returns the latest error from the stack of possible errors.
*
* @return array
* An array containing an error code and message.
*/
public function getLatestError() {
if (!empty($this->errors)) {
$last = $this->errors[count($this->errors) - 1];
return [
'code' => $last['code'],
'message' => $last['message'],
];
}
else {
return [
'code' => 1,
'message' => t('There do not seem to be any errors.'),
];
}
}
/**
* Returns the internal error array with the format below.
*
* $errors[] = array(
* 'type' => [watchdog error type],
* 'code' => [error code],
* 'message' => [message],
* );
*
* @return array|bool
* An array of errors or FALSE if the array is empty.
*/
public function getErrors() {
if (count($this->errors)) {
return $this->errors;
}
return FALSE;
}
/**
* Resets the internal error array to an empty array.
*/
public function resetErrors() {
$this->errors = [];
}
/**
* Gets all lists from Campaign Monitor.
*
* Found under the client ID given during
* object creation. The list is returned as a keyed array and cached in the
* cache table, so it may not always return the newest information.
*
* The array has the format below. Be aware that the same cache is used for
* the getListDetails() and getCustomFields() functions. This means that the
* information returned by this function may contain an extended list of
* information if any of these functions have been called.
*
* $list[$id] = array(
* 'name' => 'List name',
* );
*
* @return array|false
* An array of lists available from Campaign Monitor or FALSE on failure.
*/
public function getLists() {
if (empty($this->lists)) {
if (($cache = cache_get('campaignmonitor_lists')) && !empty($cache->data)) {
// Cache information found.
$this->lists = $cache->data;
}
else {
// Create list object and get the lists, then save the lists in the
// local cache.
if ($obj = $this
->createClientObj()) {
$result = $obj
->get_lists();
if ($result
->was_successful()) {
foreach ($result->response as $list) {
$this->lists[$list->ListID] = [
'name' => $list->Name,
];
}
cache_set('campaignmonitor_lists', $this->lists, 'cache');
}
else {
$this
->addError(WATCHDOG_ERROR, $result->response->Message, $result->http_status_code);
}
}
else {
return FALSE;
}
}
}
return $this->lists;
}
/**
* Gets list details from Campaign Monitor.
*
* This information is retrieved from
* the local cache and may be outdated. It fetches the unsubscribe link,
* confirmation success page and confirmed opt-in options.
*
* @param string $list_id
* The Campaign Monitor list ID.
*
* @return array|bool
* An array with the information or FALSE on failure.
*/
public function getListDetails($list_id) {
// If lists have not been loaded yet, get them as they build the basic
// cache.
if (empty($this->lists)) {
$this
->getLists();
}
// Test that the listId is valid.
if (!isset($this->lists[$list_id])) {
$this
->addError(WATCHDOG_ERROR, t('Unknown list id @listID.', [
'@listID' => $list_id,
]));
return FALSE;
}
// If list details are not set, create list object and fetch the information
// from the Campaign Monitor servers.
if (!isset($this->lists[$list_id]['details'])) {
if ($obj = $this
->createListObj($list_id)) {
$result = $obj
->get();
if ($result
->was_successful()) {
// Convert the return object into a keyed array.
$this->lists[$list_id]['details'] = [];
foreach ($result->response as $key => $value) {
if (!in_array($key, [
'ListID',
'Title',
])) {
$this->lists[$list_id]['details'][$key] = $value;
}
}
// Update the cache with list details.
cache_set('campaignmonitor_lists', $this->lists, 'cache');
}
else {
$this
->addError(WATCHDOG_ERROR, $result->response->Message, $result->http_status_code);
return FALSE;
}
}
else {
return FALSE;
}
}
return $this->lists[$list_id]['details'];
}
/**
* Gets custom fields.
*
* Fetch custom fields for a given list, then store this information locally
* in the list cache. The information is stored as a keyed array on the list
* array under the "CustomFields" key.
*
* @param string $list_id
* The Campaign Monitor list ID.
*
* @return array|bool
* An array with the information or FALSE on failure.
*/
public function getCustomFields($list_id) {
// If the lists have not been loaded yet, get them as they build the basic
// cache.
if (empty($this->lists)) {
$this
->getLists();
}
// Test that the listId is valid.
if (!isset($this->lists[$list_id])) {
$this
->addError(WATCHDOG_ERROR, t('Unknown list id @listID.', [
'@listID' => $list_id,
]));
return FALSE;
}
// If custom fields are not set on the list, then create the list object and
// fetch custom fields into a keyed array.
if (!isset($this->lists[$list_id]['CustomFields'])) {
if ($obj = $this
->createListObj($list_id)) {
$result = $obj
->get_custom_fields();
if ($result
->was_successful()) {
$this->lists[$list_id]['CustomFields'] = [];
foreach ($result->response as $field) {
foreach ($field as $name => $details) {
$this->lists[$list_id]['CustomFields'][$field->Key][$name] = $details;
}
}
// Update cache with list details.
cache_set('campaignmonitor_lists', $this->lists, 'cache');
}
else {
$this
->addError(WATCHDOG_ERROR, $result->response->Message, $result->http_status_code);
}
}
else {
return FALSE;
}
}
return $this->lists[$list_id]['CustomFields'];
}
/**
* Get all information available about a given list.
*
* This is done by calling
* getLists(), getListDetails() and getCustomFields(), hence building the
* local list cache.
*
* @param string $list_id
* The Campaign Monitor list ID.
*
* @return array|bool
* An array containing the list information or FALSE on failure.
*/
public function getExtendedList($list_id) {
// If the lists have not been loaded yet, get them as they build the basic
// cache.
if (empty($this->lists)) {
$this
->getLists();
}
// Test that the listId is valid.
if (!isset($this->lists[$list_id])) {
$this
->addError(WATCHDOG_ERROR, t('Unknown list id @listID.', [
'@listID' => $list_id,
]));
return FALSE;
}
// Load list details and custom fields (using is_array() since
// getCustomFields() may return an empty array).
if (!$this
->getListDetails($list_id) || !is_array($this
->getCustomFields($list_id))) {
$this
->addError(WATCHDOG_ERROR, t('Could not retrieve extended information for @listID.', [
'@listID' => $list_id,
]));
return FALSE;
}
return $this->lists[$list_id];
}
/**
* Update remote list information.
*
* The options array should have the fields
* "Title", "UnsubscribePage", "ConfirmedOptIn" and "ConfirmationSuccessPage".
* If you do not wish to set these use an empty string.
*
* @param string $list_id
* The Campaign Monitor list ID.
* @param array $options
* (optional) An array of options with information to update.
*
* @return bool
* TRUE on success, FALSE otherwise.
*/
public function updateList($list_id, array $options = []) {
// Make sure that list is loaded.
if (!$this
->getListDetails($list_id)) {
$this
->addError(WATCHDOG_ERROR, t('Could not retrieve update list information for @listID.', [
'@listID' => $list_id,
]));
return FALSE;
}
// Get list object and update the list.
if ($obj = $this
->createListObj($list_id)) {
// @todo: check that the options are correct.
$result = $obj
->update($options);
if ($result
->was_successful()) {
// Update local list cache.
$this->lists[$list_id]['name'] = $options['Title'];
$this->lists[$list_id]['details']['UnsubscribePage'] = $options['UnsubscribePage'];
$this->lists[$list_id]['details']['ConfirmedOptIn'] = $options['ConfirmedOptIn'];
$this->lists[$list_id]['details']['ConfirmationSuccessPage'] = $options['ConfirmationSuccessPage'];
// Update the cache.
cache_set('campaignmonitor_lists', $this->lists, 'cache');
return TRUE;
}
else {
$this
->addError(WATCHDOG_ERROR, $result->response->Message, $result->http_status_code);
}
}
return FALSE;
}
/**
* Fetch stats about a given list.
*
* This includes number of subscribers and unsubscribers.
* This information is temporarily stored in the local cache.
* The default timeout is 360 seconds.
*
* @param string $list_id
* The Campaign Monitor list ID.
*
* @return array|bool
* An array containing the stats or FALSE on failure.
*/
public function getListStats($list_id) {
$fetch = FALSE;
if (!isset($this->listStats[$list_id])) {
// Not found inside object, try the cache.
if (($cache = cache_get('campaignmonitor_list_stats')) && !empty($cache->data)) {
// Cache information found.
$this->listStats = $cache->data;
if (!isset($this->listStats[$list_id])) {
// Not found inside cache either.
$fetch = TRUE;
}
}
else {
// No cache found or expired.
$fetch = TRUE;
}
}
if ($fetch) {
if ($obj = $this
->createListObj($list_id)) {
// Get stats from Campaign Monitor.
$result = $obj
->get_stats();
if ($result
->was_successful()) {
$this->listStats[$list_id] = (array) $result->response;
// Update the cache.
cache_set('campaignmonitor_list_stats', $this->listStats, 'cache', $this
->getCacheTimeout());
}
else {
$this
->addError(WATCHDOG_ERROR, $result->response->Message, $result->http_status_code);
return FALSE;
}
}
else {
return FALSE;
}
}
return $this->listStats[$list_id];
}
/**
* Delete a list from Campaign Monitor.
*
* This action can not be reverted. The
* list is also removed from the local cache.
*
* @param string $list_id
* The Campaign Monitor list ID.
*
* @return bool
* TRUE on success, FALSE otherwise.
*/
public function deleteList($list_id) {
if ($obj = $this
->createListObj($list_id)) {
$result = $obj
->delete();
if ($result
->was_successful()) {
unset($this->lists[$list_id]);
cache_set('campaignmonitor_lists', $this->lists, 'cache');
return TRUE;
}
else {
$this
->addError(WATCHDOG_ERROR, $result->response->Message, $result->http_status_code);
return FALSE;
}
}
return FALSE;
}
/**
* Create a new list at the Campaign Monitor servers.
*
* The side-effect is that
* the local cache is cleared.
*
* @param string $title
* The title of the new list.
* @param string $unsubscribe_page
* An optional page to redirect subscribers to when they unsubscribe.
* @param bool $confirmed_opt_in
* Whether or not this list requires to confirm the subscription. Defaults
* to FALSE.
* @param string $success_page
* An optional page to redirect subscribers to when they confirm their
* subscription.
*
* @return bool
* TRUE on success, FALSE otherwise.
*/
public function createList($title, $unsubscribe_page = '', $confirmed_opt_in = FALSE, $success_page = '') {
if ($obj = $this
->createListObj(NULL)) {
$result = $obj
->create($this->clientId, [
'Title' => check_plain($title),
'UnsubscribePage' => check_plain($unsubscribe_page),
'ConfirmedOptIn' => $confirmed_opt_in,
'ConfirmationSuccessPage' => check_plain($success_page),
]);
if ($result
->was_successful()) {
// Clear the cache, so the list information can be retrieved again.
$this
->clearCache();
return TRUE;
}
else {
$this
->addError(WATCHDOG_ERROR, $result->response->Message, $result->http_status_code);
return FALSE;
}
}
return FALSE;
}
/**
* Get basic information about campaigns in the form of a keyed array.
*
* The information is stored locally in a temporary cache.
*
* The array is formatted like this:
*
* $campaigns[$id] => array(
* 'Name' => 'Campaign Name',
* 'Subject' => 'Campaign subject line',
* 'Sent' => 'Unix timestamp',
* 'Recipients' => 'The number of recipients',
* 'Link' => 'Online URL to the campaign',
* );
*
* @return array|bool
* An array with the campaigns or FALSE on failure.
*/
public function getCampaigns() {
if (empty($this->campaigns)) {
if (($cache = cache_get('campaignmonitor_campaigns')) && !empty($cache->data)) {
// Cache information found.
$this->campaigns = $cache->data;
}
else {
if ($obj = $this
->createClientObj()) {
$result = $obj
->get_campaigns();
if ($result
->was_successful()) {
// Build an array for each campaign returned.
foreach ($result->response as $campaign) {
$this->campaigns[$campaign->CampaignID] = [
'Name' => $campaign->Name,
'Subject' => $campaign->Subject,
'Sent' => strtotime($campaign->SentDate),
'Recipients' => $campaign->TotalRecipients,
'Link' => $campaign->WebVersionURL,
];
}
// Save campaigns in the cache.
cache_set('campaignmonitor_campaigns', $this->campaigns, 'cache', $this
->getCacheTimeout());
}
else {
$this
->addError(WATCHDOG_ERROR, $result->response->Message, $result->http_status_code);
return FALSE;
}
}
else {
return FALSE;
}
}
}
return $this->campaigns;
}
/**
* Get values entered by the subscriber.
*
* @param string $list_id
* The unique Campaign Monitor list ID.
* @param string $email
* The e-mail address that identifies the subscriber.
*
* @return array|bool
* An array containing subscriber information or FALSE on failure.
*/
public function getSubscriber($list_id, $email) {
$fetch = FALSE;
if (!isset($this->subscribers[$list_id . $email])) {
// Not found inside object, try the cache.
if (($cache = cache_get('campaignmonitor_subscribers')) && !empty($cache->data)) {
// Cache information found.
$this->subscribers = $cache->data;
if (!isset($this->subscribers[$list_id . $email])) {
// Not found inside cache either.
$fetch = TRUE;
}
}
else {
// No cache found or expired.
$fetch = TRUE;
}
}
if ($fetch) {
if ($obj = $this
->createSubscriberObj($list_id)) {
$this->subscribers[$list_id . $email] = [];
$result = $obj
->get($email);
if ($result
->was_successful()) {
foreach ($result->response as $key => $value) {
if ($key == 'CustomFields') {
// Convert the custom fields object into a keyed array.
$this->subscribers[$list_id . $email][$key] = [];
foreach ($value as $field) {
// Check if the field has been set. If not, set the value.
if (!isset($this->subscribers[$list_id . $email][$key][$field->Key])) {
$this->subscribers[$list_id . $email][$key][$field->Key] = $field->Value;
}
elseif (!is_array($this->subscribers[$list_id . $email][$key][$field->Key])) {
// If the field is not an array, assign an array to the
// field, containing the previous value of the field and
// this new value.
$this->subscribers[$list_id . $email][$key][$field->Key] = [
$this->subscribers[$list_id . $email][$key][$field->Key],
$field->Value,
];
}
else {
$this->subscribers[$list_id . $email][$key][$field->Key][] = $field->Value;
}
}
}
else {
$this->subscribers[$list_id . $email][$key] = $value;
}
}
// Save the subscriber information in the cache.
cache_set('campaignmonitor_subscribers', $this->subscribers, 'cache', $this
->getCacheTimeout());
}
else {
$this
->addError(WATCHDOG_ERROR, $result->response->Message, $result->http_status_code);
return [];
}
}
else {
return FALSE;
}
}
return $this->subscribers[$list_id . $email];
}
/**
* Check if a given user, identified by e-mail address, is subscribed.
*
* @param string $list_id
* The unique Campaign Monitor list ID.
* @param string $email
* The user's e-mail address.
*
* @return bool
* TRUE if subscribed, FALSE if not.
*/
public function isSubscribed($list_id, $email) {
$result = $this
->getSubscriber($list_id, $email);
if (!empty($result)) {
if ($result['State'] == 'Active') {
return TRUE;
}
}
return FALSE;
}
/**
* Remove subscribers from local cache.
*
* This forces the data to be fetched
* from Campaign Monitor at the next request. This function should be used in
* connection with updating subscriber information.
*
* @param string $list_id
* The unique Campaign Monitor list ID.
* @param string $email
* The e-mail address to be removed from cache.
*/
public function removeSubscriberFromCache($list_id, $email) {
if (($cache = cache_get('campaignmonitor_subscribers')) && !empty($cache->data)) {
// Cache information found.
$this->subscribers = $cache->data;
if (isset($this->subscribers[$list_id . $email])) {
// Subscriber found in the cache, so remove it.
unset($this->subscribers[$list_id . $email]);
cache_set('campaignmonitor_subscribers', $this->subscribers, 'cache', $this
->getCacheTimeout());
}
}
}
/**
* Subscribe a user to a given list, with information entered.
*
* If the user is already subscribed to the list, the information will be
* updated with the new values.
*
* @param string $list_id
* The unique Campaign Monitor list ID.
* @param string $email
* The e-mail address that identifies the user.
* @param string $name
* Optionally the name of the user.
* @param array $custom_fields
* Optionally some custom fields that were defined in Campaign Monitor.
*
* @return bool
* TRUE on success, FALSE otherwise.
*/
public function subscribe($list_id, $email, $name = '', array $custom_fields = []) {
if ($obj = $this
->createSubscriberObj($list_id)) {
$data = [
'EmailAddress' => $email,
'Name' => $name,
'CustomFields' => $custom_fields,
'ConsentToTrack' => 'yes',
'Resubscribe' => TRUE,
];
drupal_alter('campaignmonitor_subscriber_data', $data, $list_id);
$result = $obj
->add($data);
if (!$result
->was_successful()) {
$this
->addError(WATCHDOG_ERROR, $result->response->Message, $result->http_status_code);
return FALSE;
}
$this
->removeSubscriberFromCache($list_id, $email);
return TRUE;
}
return FALSE;
}
/**
* Unsubscribe a given user, identified by e-mail address, from a given list.
*
* @param string $list_id
* The unique Campaign Monitor list ID.
* @param string $email
* The e-mail address that identifies the user.
*
* @return bool
* TRUE on success, FALSE otherwise.
*/
public function unsubscribe($list_id, $email) {
if ($obj = $this
->createSubscriberObj($list_id)) {
$result = $obj
->unsubscribe($email);
if (!$result
->was_successful()) {
$this
->addError(WATCHDOG_ERROR, $result->response->Message, $result->http_status_code);
return FALSE;
}
$this
->removeSubscriberFromCache($list_id, $email);
return TRUE;
}
return FALSE;
}
/**
* Updates the subscriber e-mail address for a given list.
*
* @param string $list_id
* The unique Campaign Monitor list ID.
* @param string $old_email
* The old e-mail address.
* @param string $email
* The new e-mail address.
*
* @return bool
* TRUE on success, FALSE otherwise.
*/
public function updateSubscriberEmail($list_id, $old_email, $email) {
if ($obj = $this
->createSubscriberObj($list_id)) {
$result = $obj
->update($old_email, [
'EmailAddress' => $email,
'Resubscribe' => TRUE,
]);
if (!$result
->was_successful()) {
$this
->addError(WATCHDOG_ERROR, $result->response->Message, $result->http_status_code);
return FALSE;
}
// Remove the old e-mail address from the subscriber cache.
$this
->removeSubscriberFromCache($list_id, $old_email);
return TRUE;
}
}
/**
* Clears all the caches used by this wrapper object.
*/
public function clearCache() {
cache_clear_all('campaignmonitor_lists', 'cache');
cache_clear_all('campaignmonitor_list_stats', 'cache');
cache_clear_all('campaignmonitor_campaigns', 'cache');
cache_clear_all('campaignmonitor_subscribers', 'cache');
}
}Classes
Name |
Description |
|---|---|
| CampaignMonitor | Implementation of the CampaignMonitor class. |