class MandrillAPI in Mandrill 8
Service class to integrate with Mandrill.
Hierarchy
- class \Drupal\mandrill\MandrillAPI implements MandrillAPIInterface
Expanded class hierarchy of MandrillAPI
1 string reference to 'MandrillAPI'
1 service uses MandrillAPI
File
- src/
MandrillAPI.php, line 11
Namespace
Drupal\mandrillView source
class MandrillAPI implements MandrillAPIInterface {
/**
* The Config Factory service.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $config;
/**
* The Logger Factory service.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $log;
/**
* Constructs the service.
*
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* @param \Drupal\Core\Logger\LoggerChannelFactoryInterface $logger_factory.
*/
public function __construct(ConfigFactoryInterface $config_factory, LoggerChannelFactoryInterface $logger_factory) {
$this->config = $config_factory
->get('mandrill.settings');
$this->log = $logger_factory
->get('mandrill');
}
/**
* Check if the Mandrill PHP library is available.
*
* @return bool
* TRUE if it is installed, FALSE otherwise.
*/
public function isLibraryInstalled() {
return class_exists('Mandrill');
}
/**
* Gets messages received by an email address.
*
* @param $email
* The email address of the message recipient.
*
* @return array
*/
public function getMessages($email) {
$messages = array();
try {
if ($mandrill = $this
->getAPIObject()) {
$messages = $mandrill->messages
->search("email:{$email}");
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $messages;
}
/**
* Gets a list of mandrill template objects.
*
* @return array
* An of available templates with complete data or NULL if none available.
*/
public function getTemplates() {
$templates = NULL;
try {
if ($mandrill = $this
->getAPIObject()) {
$templates = $mandrill->templates
->getList();
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $templates;
}
/**
* Gets a list of sub accounts.
*
* @return array
*/
public function getSubAccounts() {
$accounts = array();
try {
if ($mandrill = $this
->getAPIObject()) {
$accounts = $mandrill->subaccounts
->getList();
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $accounts;
}
/**
* Gets a list of webhooks.
*
* @return array
*/
public function getWebhooks() {
$webhooks = array();
try {
if ($mandrill = $this
->getAPIObject()) {
$webhooks = $mandrill->webhooks
->getList();
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $webhooks;
}
/**
* Gets a list of inbound domains.
*
* @return array
*/
public function getInboundDomains() {
$domains = array();
try {
if ($mandrill = $this
->getAPIObject()) {
$domains = $mandrill->inbound
->domains();
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $domains;
}
/**
* Gets current API user information.
*
* @return array
*/
public function getUser() {
$users = array();
try {
if ($mandrill = $this
->getAPIObject()) {
$users = $mandrill->users
->info();
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $users;
}
/**
* Gets a list of tags.
*
* @return array
*/
public function getTags() {
$tags = array();
try {
if ($mandrill = $this
->getAPIObject()) {
$tags = $mandrill->tags
->info();
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $tags;
}
/**
* Gets a single tag.
*
* @param string $tag
* The tag as a string.
*
* @return array
* The tag information.
*/
public function getTag($tag) {
$tag = NULL;
try {
if ($mandrill = $this
->getAPIObject()) {
$tag = $mandrill->tags
->info($tag);
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $tag;
}
/**
* Gets recent history for a tag.
*
* @param string $tag
* The tag as a string.
*
* @return array
* Array of tag history.
*/
public function getTagTimeSeries($tag) {
$data = array();
try {
if ($mandrill = $this
->getAPIObject()) {
$data = $mandrill->tags
->timeSeries($tag);
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $data;
}
/**
* Gets recent history for all tags.
*
* @return array
* Array of tag history.
*/
public function getTagsAllTimeSeries() {
$data = array();
try {
if ($mandrill = $this
->getAPIObject()) {
$data = $mandrill->tags
->allTimeSeries();
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $data;
}
/**
* Gets a list of senders.
*
* @return array
*/
public function getSenders() {
$senders = array();
try {
if ($mandrill = $this
->getAPIObject()) {
$senders = $mandrill->senders
->getList();
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $senders;
}
/**
* Gets a single sender.
*
* @param string $email
* The email address of the sender.
*
* @return array
* The sender information.
*/
public function getSender($email) {
$sender = NULL;
try {
if ($mandrill = $this
->getAPIObject()) {
$sender = $mandrill->senders
->info($email);
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $sender;
}
/**
* Gets recent history for a sender.
*
* @param string $email
* The email address of the sender.
*
* @return array
* Array of sender history.
*/
public function getSenderTimeSeries($email) {
$data = array();
try {
if ($mandrill = $this
->getAPIObject()) {
$data = $mandrill->senders
->timeSeries($email);
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $data;
}
/**
* Gets the 100 most-clicked URLs.
*
* @return array
* Array of URL objects.
*/
public function getURLs() {
$urls = array();
try {
if ($mandrill = $this
->getAPIObject()) {
$urls = $mandrill->urls
->getList();
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $urls;
}
/**
* Gets recent history for a URL.
*
* @param string $url
* The URL.
*
* @return array
* Array of URL history.
*/
public function getURLTimeSeries($url) {
$data = array();
try {
if ($mandrill = $this
->getAPIObject()) {
$data = $mandrill->urls
->timeSeries($url);
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $data;
}
/**
* Gets a list of inbound routes.
*
* @return array
*/
public function getInboundRoutes() {
$routes = array();
try {
if ($mandrill = $this
->getAPIObject()) {
$routes = $mandrill->inbound
->routes();
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $routes;
}
/**
* Creates a new inbound domain.
*
* @param string $domain
* The domain name.
*
* @return array
*/
public function addInboundDomain($domain) {
$result = NULL;
try {
if ($mandrill = $this
->getAPIObject()) {
$result = $mandrill->inbound
->addDomain($domain);
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $result;
}
/**
* Creates a new webhook.
*
* @param string $path
* @param array $events
* @param string $description
*
* @return array
* The created Mandrill webhook object.
*/
public function addWebhook($path, $events, $description = 'Drupal Webhook') {
$result = NULL;
try {
if ($mandrill = $this
->getAPIObject()) {
$result = $mandrill->webhooks
->add($GLOBALS['base_url'] . '/' . $path, $description, $events);
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $result;
}
/**
* Deletes an inbound domain.
*
* @param string $domain
* The domain name.
*
* @return array
*/
public function deleteInboundDomain($domain) {
$result = NULL;
try {
if ($mandrill = $this
->getAPIObject()) {
$result = $mandrill->inbound
->deleteDomain($domain);
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $result;
}
/**
* Adds a new inbound route for a domain.
*
* @param string $domain
* An existing inbound domain name.
* @param string $pattern
* The search pattern that the mailbox name should match.
* @param string $url
* The webhook URL where the inbound messages will be published.
*
* @return array
*/
public function addInboundRoute($domain, $pattern, $url) {
$result = NULL;
try {
if ($mandrill = $this
->getAPIObject()) {
$result = $mandrill->inbound
->addRoute($domain, $pattern, $url);
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $result;
}
/**
* Sends a templated Mandrill message.
*
* This function checks for appropriate settings in the message, then uses the
* template API call to send the message if the settings are valid.
*
* @param array $message
* @param string $template_id
* @param array $template_content
*
* @return array
* Array of message objects, one per recipient.
*/
public function sendTemplate($message, $template_id, $template_content) {
$result = NULL;
try {
if ($mandrill = $this
->getAPIObject()) {
$result = $mandrill->messages
->sendTemplate($template_id, $template_content, $message);
}
} catch (\Exception $e) {
\Drupal::messenger()
->addError(t('Mandrill: %message', array(
'%message' => $e
->getMessage(),
)));
$this->log
->error($e
->getMessage());
}
return $result;
}
/**
* The function that calls the API send message.
*
* This is the default function used by mandrill_mailsend().
*
* @param array $message
* Associative array containing message data.
* @return array
* Results of sending the message.
*
* @throws \Exception
*/
public function send(array $message) {
if ($mailer = $this
->getAPIObject()) {
return $mailer->messages
->send($message);
}
else {
throw new \Exception('Could not load Mandrill API.');
}
}
/**
* Return Mandrill API object for communication with the mandrill server.
*
* @param bool $reset
* Pass in TRUE to reset the statically cached object.
*
* @return \Mandrill|bool
* Mandrill Object upon success
* FALSE if 'mandrill_api_key' is unset
*/
private function getAPIObject($reset = FALSE) {
$api =& drupal_static(__FUNCTION__, NULL);
if ($api === NULL || $reset) {
if (!$this
->isLibraryInstalled()) {
$msg = t('Failed to load Mandrill PHP library. Please refer to the installation requirements.');
$this->log
->error($msg);
\Drupal::messenger()
->addError($msg);
return NULL;
}
$api_key = $this->config
->get('mandrill_api_key');
$api_timeout = $this->config
->get('mandrill_api_timeout');
if (empty($api_key)) {
$msg = t('Failed to load Mandrill API Key. Please check your Mandrill settings.');
$this->log
->error($msg);
\Drupal::messenger()
->addError($msg);
return FALSE;
}
// We allow the class name to be overridden, following the example of core's
// mailsystem, in order to use alternate Mandrill classes.
$className = $this->config
->get('mandrill_api_classname');
$api = new $className($api_key, $api_timeout);
}
return $api;
}
}Members
Name |
Modifiers | Type | Description | Overrides |
|---|---|---|---|---|
|
MandrillAPI:: |
protected | property | The Config Factory service. | |
|
MandrillAPI:: |
protected | property | The Logger Factory service. | |
|
MandrillAPI:: |
public | function |
Creates a new inbound domain. Overrides MandrillAPIInterface:: |
|
|
MandrillAPI:: |
public | function |
Adds a new inbound route for a domain. Overrides MandrillAPIInterface:: |
|
|
MandrillAPI:: |
public | function |
Creates a new webhook. Overrides MandrillAPIInterface:: |
|
|
MandrillAPI:: |
public | function |
Deletes an inbound domain. Overrides MandrillAPIInterface:: |
|
|
MandrillAPI:: |
private | function | Return Mandrill API object for communication with the mandrill server. | |
|
MandrillAPI:: |
public | function |
Gets a list of inbound domains. Overrides MandrillAPIInterface:: |
|
|
MandrillAPI:: |
public | function |
Gets a list of inbound routes. Overrides MandrillAPIInterface:: |
|
|
MandrillAPI:: |
public | function |
Gets messages received by an email address. Overrides MandrillAPIInterface:: |
1 |
|
MandrillAPI:: |
public | function |
Gets a single sender. Overrides MandrillAPIInterface:: |
|
|
MandrillAPI:: |
public | function |
Gets a list of senders. Overrides MandrillAPIInterface:: |
1 |
|
MandrillAPI:: |
public | function |
Gets recent history for a sender. Overrides MandrillAPIInterface:: |
|
|
MandrillAPI:: |
public | function |
Gets a list of sub accounts. Overrides MandrillAPIInterface:: |
1 |
|
MandrillAPI:: |
public | function |
Gets a single tag. Overrides MandrillAPIInterface:: |
|
|
MandrillAPI:: |
public | function |
Gets a list of tags. Overrides MandrillAPIInterface:: |
1 |
|
MandrillAPI:: |
public | function |
Gets recent history for all tags. Overrides MandrillAPIInterface:: |
1 |
|
MandrillAPI:: |
public | function |
Gets recent history for a tag. Overrides MandrillAPIInterface:: |
|
|
MandrillAPI:: |
public | function |
Gets a list of mandrill template objects. Overrides MandrillAPIInterface:: |
1 |
|
MandrillAPI:: |
public | function |
Gets the 100 most-clicked URLs. Overrides MandrillAPIInterface:: |
1 |
|
MandrillAPI:: |
public | function |
Gets recent history for a URL. Overrides MandrillAPIInterface:: |
|
|
MandrillAPI:: |
public | function |
Gets current API user information. Overrides MandrillAPIInterface:: |
1 |
|
MandrillAPI:: |
public | function |
Gets a list of webhooks. Overrides MandrillAPIInterface:: |
|
|
MandrillAPI:: |
public | function |
Check if the Mandrill PHP library is available. Overrides MandrillAPIInterface:: |
|
|
MandrillAPI:: |
public | function |
The function that calls the API send message. Overrides MandrillAPIInterface:: |
1 |
|
MandrillAPI:: |
public | function |
Sends a templated Mandrill message. Overrides MandrillAPIInterface:: |
1 |
|
MandrillAPI:: |
public | function | Constructs the service. |