added mailgun module

sites/all/libraries/mailgun/src/Mailgun/Messages/BatchMessage.php

@@ -0,0 +1,141 @@
+<?PHP
+
+namespace Mailgun\Messages;
+
+use Mailgun\Constants\Api;
+use Mailgun\Constants\ExceptionMessages;
+use Mailgun\Messages\Exceptions\TooManyParameters;
+use Mailgun\Messages\Exceptions\MissingRequiredMIMEParameters;
+
+/**
+ * This class is used for batch sending. See the official documentation (link below)
+ * for usage instructions.
+ *
+ * @link https://github.com/mailgun/mailgun-php/blob/master/src/Mailgun/Messages/README.md
+ */
+class BatchMessage extends MessageBuilder{
+
+    /**
+     * @var array
+     */
+	private $batchRecipientAttributes;
+
+    /**
+     * @var boolean
+     */
+	private $autoSend;
+
+    /**
+     * @var \Mailgun\Connection\RestClient
+     */
+	private $restClient;
+
+    /**
+     * @var string
+     */
+	private $workingDomain;
+
+    /**
+     * @var array
+     */
+	private $messageIds = array();
+
+    /**
+     * @param \Mailgun\Connection\RestClient $restClient
+     * @param string $workingDomain
+     * @param boolean $autoSend
+     */
+	public function __construct($restClient, $workingDomain, $autoSend){
+		$this->batchRecipientAttributes = array();
+		$this->autoSend = $autoSend;
+		$this->restClient = $restClient;
+		$this->workingDomain = $workingDomain;
+		$this->endpointUrl = $workingDomain . "/messages";
+	}
+
+    /**
+     * @param string $headerName
+     * @param string $address
+     * @param array $variables
+     * @throws MissingRequiredMIMEParameters
+     * @throws TooManyParameters
+     */
+	protected function addRecipient($headerName, $address, $variables){
+		if(array_key_exists($headerName, $this->counters['recipients'])){
+			if($this->counters['recipients'][$headerName] == Api::RECIPIENT_COUNT_LIMIT){
+				if($this->autoSend == false){
+					throw new TooManyParameters(ExceptionMessages::TOO_MANY_RECIPIENTS);
+				}
+				$this->sendMessage();
+			}
+		}
+
+		$compiledAddress = $this->parseAddress($address, $variables);
+
+		if(isset($this->message[$headerName])){
+			array_push($this->message[$headerName], $compiledAddress);
+		}
+		elseif($headerName == "h:reply-to"){
+			$this->message[$headerName] = $compiledAddress;
+		}
+		else{
+			$this->message[$headerName] = array($compiledAddress);
+		}
+
+		if(array_key_exists($headerName, $this->counters['recipients'])){
+			$this->counters['recipients'][$headerName] += 1;
+			if(!array_key_exists("id", $variables)){
+				$variables['id'] = $this->counters['recipients'][$headerName];
+			}
+		}
+		$this->batchRecipientAttributes["$address"] = $variables;
+	}
+
+    /**
+     * @param array $message
+     * @param array $files
+     * @throws MissingRequiredMIMEParameters
+     */
+	public function sendMessage($message = array(), $files = array()){
+		if(count($message) < 1){
+			$message = $this->message;
+			$files = $this->files;
+		}
+		if(!array_key_exists("from", $message)){
+			throw new MissingRequiredMIMEParameters(ExceptionMessages::EXCEPTION_MISSING_REQUIRED_MIME_PARAMETERS);
+		}
+		elseif(!array_key_exists("to", $message)){
+			throw new MissingRequiredMIMEParameters(ExceptionMessages::EXCEPTION_MISSING_REQUIRED_MIME_PARAMETERS);
+		}
+		elseif(!array_key_exists("subject", $message)){
+			throw new MissingRequiredMIMEParameters(ExceptionMessages::EXCEPTION_MISSING_REQUIRED_MIME_PARAMETERS);
+		}
+		elseif((!array_key_exists("text", $message) && !array_key_exists("html", $message))){
+			throw new MissingRequiredMIMEParameters(ExceptionMessages::EXCEPTION_MISSING_REQUIRED_MIME_PARAMETERS);
+		}
+		else{
+			$message["recipient-variables"] = json_encode($this->batchRecipientAttributes);
+			$response = $this->restClient->post($this->endpointUrl, $message, $files);
+			$this->batchRecipientAttributes = array();
+			$this->counters['recipients']['to'] = 0;
+			$this->counters['recipients']['cc'] = 0;
+			$this->counters['recipients']['bcc'] = 0;
+			unset($this->message["to"]);
+			array_push($this->messageIds, $response->http_response_body->id);
+		}
+	}
+
+    /**
+     * @throws MissingRequiredMIMEParameters
+     */
+	public function finalize(){
+		$this->sendMessage();
+	}
+
+    /**
+     * @return string[]
+     */
+	public function getMessageIds(){
+		return $this->messageIds;
+	}
+}

sites/all/libraries/mailgun/src/Mailgun/Messages/Exceptions/InvalidParameter.php

@@ -0,0 +1,4 @@
+<?php
+namespace Mailgun\Messages\Exceptions;
+
+class InvalidParameter extends \Exception{}

sites/all/libraries/mailgun/src/Mailgun/Messages/Exceptions/InvalidParameterType.php

@@ -0,0 +1,4 @@
+<?php
+namespace Mailgun\Messages\Exceptions;
+
+class InvalidParameterType extends \Exception{}

sites/all/libraries/mailgun/src/Mailgun/Messages/Exceptions/MissingRequiredMIMEParameters.php

@@ -0,0 +1,4 @@
+<?php
+namespace Mailgun\Messages\Exceptions;
+
+class MissingRequiredMIMEParameters extends \Exception{}

sites/all/libraries/mailgun/src/Mailgun/Messages/Exceptions/TooManyParameters.php

@@ -0,0 +1,4 @@
+<?php
+namespace Mailgun\Messages\Exceptions;
+
+class TooManyParameters extends \Exception{}

sites/all/libraries/mailgun/src/Mailgun/Messages/MessageBuilder.php

@@ -0,0 +1,482 @@
+<?PHP
+
+namespace Mailgun\Messages;
+
+use Mailgun\Constants\Api;
+use Mailgun\Constants\ExceptionMessages;
+use Mailgun\Messages\Exceptions\InvalidParameter;
+use Mailgun\Messages\Exceptions\TooManyParameters;
+
+/**
+ * This class is used for composing a properly formed
+ * message object. Dealing with arrays can be cumbersome,
+ * this class makes the process easier. See the official
+ * documentation (link below) for usage instructions.
+ *
+ * @link https://github.com/mailgun/mailgun-php/blob/master/src/Mailgun/Messages/README.md
+ */
+class MessageBuilder
+{
+    /**
+     * @var array
+     */
+    protected $message = array();
+
+    /**
+     * @var array
+     */
+    protected $variables = array();
+
+    /**
+     * @var array
+     */
+    protected $files = array();
+
+    /**
+     * @var array
+     */
+    protected $counters = array(
+        'recipients' => array(
+            'to'  => 0,
+            'cc'  => 0,
+            'bcc' => 0
+        ),
+        'attributes' => array(
+            'attachment'    => 0,
+            'campaign_id'   => 0,
+            'custom_option' => 0,
+            'tag'           => 0
+        )
+    );
+
+    /**
+     * @param array $params
+     * @param string $key
+     * @param mixed $default
+     * @return mixed
+     */
+    protected function safeGet($params, $key, $default)
+    {
+        if (array_key_exists($key, $params)) {
+            return $params[$key];
+        }
+
+        return $default;
+    }
+
+    /**
+     * @param array $params
+     * @return mixed|string
+     */
+    protected function getFullName($params)
+    {
+        if (array_key_exists("first", $params)) {
+            $first = $this->safeGet($params, "first", "");
+            $last  = $this->safeGet($params, "last", "");
+
+            return trim("$first $last");
+        }
+
+        return $this->safeGet($params, "full_name", "");
+    }
+
+    /**
+     * @param string $address
+     * @param array $variables
+     * @return string
+     */
+    protected function parseAddress($address, $variables)
+    {
+        if (!is_array($variables)) {
+            return $address;
+        }
+        $fullName = $this->getFullName($variables);
+        if ($fullName != null) {
+            return "'$fullName' <$address>";
+        }
+
+        return $address;
+    }
+
+    /**
+     * @param string $headerName
+     * @param string $address
+     * @param array $variables
+     */
+    protected function addRecipient($headerName, $address, $variables)
+    {
+        $compiledAddress = $this->parseAddress($address, $variables);
+
+        if (isset($this->message[$headerName])) {
+            array_push($this->message[$headerName], $compiledAddress);
+        } elseif ($headerName == "h:reply-to") {
+            $this->message[$headerName] = $compiledAddress;
+        } else {
+            $this->message[$headerName] = array($compiledAddress);
+        }
+        if (array_key_exists($headerName, $this->counters['recipients'])) {
+            $this->counters['recipients'][$headerName] += 1;
+        }
+    }
+
+    /**
+     * @param string $address
+     * @param array|null $variables
+     * @return mixed
+     * @throws TooManyParameters
+     */
+    public function addToRecipient($address, $variables = null)
+    {
+        if ($this->counters['recipients']['to'] > Api::RECIPIENT_COUNT_LIMIT) {
+            throw new TooManyParameters(ExceptionMessages::TOO_MANY_PARAMETERS_RECIPIENT);
+        }
+        $this->addRecipient("to", $address, $variables);
+
+        return end($this->message['to']);
+    }
+
+    /**
+     * @param string $address
+     * @param array|null $variables
+     * @return mixed
+     * @throws TooManyParameters
+     */
+    public function addCcRecipient($address, $variables = null)
+    {
+        if ($this->counters['recipients']['cc'] > Api::RECIPIENT_COUNT_LIMIT) {
+            throw new TooManyParameters(ExceptionMessages::TOO_MANY_PARAMETERS_RECIPIENT);
+        }
+        $this->addRecipient("cc", $address, $variables);
+
+        return end($this->message['cc']);
+    }
+
+    /**
+     * @param string $address
+     * @param array|null $variables
+     * @return mixed
+     * @throws TooManyParameters
+     */
+    public function addBccRecipient($address, $variables = null)
+    {
+        if ($this->counters['recipients']['bcc'] > Api::RECIPIENT_COUNT_LIMIT) {
+            throw new TooManyParameters(ExceptionMessages::TOO_MANY_PARAMETERS_RECIPIENT);
+        }
+        $this->addRecipient("bcc", $address, $variables);
+
+        return end($this->message['bcc']);
+    }
+
+    /**
+     * @param string $address
+     * @param array|null $variables
+     * @return mixed
+     */
+    public function setFromAddress($address, $variables = null)
+    {
+        $this->addRecipient("from", $address, $variables);
+
+        return $this->message['from'];
+    }
+
+    /**
+     * @param string $address
+     * @param array|null $variables
+     * @return mixed
+     */
+    public function setReplyToAddress($address, $variables = null)
+    {
+        $this->addRecipient("h:reply-to", $address, $variables);
+
+        return $this->message['h:reply-to'];
+    }
+
+    /**
+     * @param string $subject
+     * @return mixed
+     */
+    public function setSubject($subject = "")
+    {
+        if ($subject == null || $subject == "") {
+            $subject = " ";
+        }
+        $this->message['subject'] = $subject;
+
+        return $this->message['subject'];
+    }
+
+    /**
+     * @param string $headerName
+     * @param mixed $headerData
+     * @return mixed
+     */
+    public function addCustomHeader($headerName, $headerData)
+    {
+        if (!preg_match("/^h:/i", $headerName)) {
+            $headerName = "h:" . $headerName;
+        }
+        $this->message[$headerName] = array($headerData);
+
+        return $this->message[$headerName];
+    }
+
+    /**
+     * @param string $textBody
+     * @return string
+     */
+    public function setTextBody($textBody)
+    {
+        if ($textBody == null || $textBody == "") {
+            $textBody = " ";
+        }
+        $this->message['text'] = $textBody;
+
+        return $this->message['text'];
+    }
+
+    /**
+     * @param string $htmlBody
+     * @return string
+     */
+    public function setHtmlBody($htmlBody)
+    {
+        if ($htmlBody == null || $htmlBody == "") {
+            $htmlBody = " ";
+        }
+        $this->message['html'] = $htmlBody;
+
+        return $this->message['html'];
+    }
+
+    /**
+     * @param string $attachmentPath
+     * @param string|null $attachmentName
+     * @return bool
+     */
+    public function addAttachment($attachmentPath, $attachmentName = null)
+    {
+        if (isset($this->files["attachment"])) {
+            $attachment = array(
+                'filePath'   => $attachmentPath,
+                'remoteName' => $attachmentName
+            );
+            array_push($this->files["attachment"], $attachment);
+        } else {
+            $this->files["attachment"] = array(
+                array(
+                    'filePath'   => $attachmentPath,
+                    'remoteName' => $attachmentName
+                )
+            );
+        }
+
+        return true;
+    }
+
+    /**
+     * @param string $inlineImagePath
+     * @param string|null $inlineImageName
+     * @throws InvalidParameter
+     */
+    public function addInlineImage($inlineImagePath, $inlineImageName = null)
+    {
+        if (preg_match("/^@/", $inlineImagePath)) {
+            if (isset($this->files['inline'])) {
+                $inlineAttachment = array(
+                    'filePath'   => $inlineImagePath,
+                    'remoteName' => $inlineImageName
+                );
+                array_push($this->files['inline'], $inlineAttachment);
+            } else {
+                $this->files['inline'] = array(
+                    array(
+                        'filePath'   => $inlineImagePath,
+                        'remoteName' => $inlineImageName
+                    )
+                );
+            }
+
+            return true;
+        } else {
+            throw new InvalidParameter(ExceptionMessages::INVALID_PARAMETER_INLINE);
+        }
+    }
+
+    /**
+     * @param boolean $testMode
+     * @return string
+     */
+    public function setTestMode($testMode)
+    {
+        if (filter_var($testMode, FILTER_VALIDATE_BOOLEAN)) {
+            $testMode = "yes";
+        } else {
+            $testMode = "no";
+        }
+        $this->message['o:testmode'] = $testMode;
+
+        return $this->message['o:testmode'];
+    }
+
+    /**
+     * @param string|int $campaignId
+     * @return string|int
+     * @throws TooManyParameters
+     */
+    public function addCampaignId($campaignId)
+    {
+        if ($this->counters['attributes']['campaign_id'] < Api::CAMPAIGN_ID_LIMIT) {
+            if (isset($this->message['o:campaign'])) {
+                array_push($this->message['o:campaign'], $campaignId);
+            } else {
+                $this->message['o:campaign'] = array($campaignId);
+            }
+            $this->counters['attributes']['campaign_id'] += 1;
+
+            return $this->message['o:campaign'];
+        } else {
+            throw new TooManyParameters(ExceptionMessages::TOO_MANY_PARAMETERS_CAMPAIGNS);
+        }
+    }
+
+    /**
+     * @param string $tag
+     * @throws TooManyParameters
+     */
+    public function addTag($tag)
+    {
+        if ($this->counters['attributes']['tag'] < Api::TAG_LIMIT) {
+            if (isset($this->message['o:tag'])) {
+                array_push($this->message['o:tag'], $tag);
+            } else {
+                $this->message['o:tag'] = array($tag);
+            }
+            $this->counters['attributes']['tag'] += 1;
+
+            return $this->message['o:tag'];
+        } else {
+            throw new TooManyParameters(ExceptionMessages::TOO_MANY_PARAMETERS_TAGS);
+        }
+    }
+
+    /**
+     * @param boolean $enabled
+     * @return mixed
+     */
+    public function setDkim($enabled)
+    {
+        if (filter_var($enabled, FILTER_VALIDATE_BOOLEAN)) {
+            $enabled = "yes";
+        } else {
+            $enabled = "no";
+        }
+        $this->message["o:dkim"] = $enabled;
+
+        return $this->message["o:dkim"];
+    }
+
+    /**
+     * @param boolean $enabled
+     * @return string
+     */
+    public function setOpenTracking($enabled)
+    {
+        if (filter_var($enabled, FILTER_VALIDATE_BOOLEAN)) {
+            $enabled = "yes";
+        } else {
+            $enabled = "no";
+        }
+        $this->message['o:tracking-opens'] = $enabled;
+
+        return $this->message['o:tracking-opens'];
+    }
+
+    /**
+     * @param boolean $enabled
+     * @return string
+     */
+    public function setClickTracking($enabled)
+    {
+        if (filter_var($enabled, FILTER_VALIDATE_BOOLEAN)) {
+            $enabled = "yes";
+        } elseif ($enabled == "html") {
+            $enabled = "html";
+        } else {
+            $enabled = "no";
+        }
+        $this->message['o:tracking-clicks'] = $enabled;
+
+        return $this->message['o:tracking-clicks'];
+    }
+
+    /**
+     * @param string $timeDate
+     * @param string|null $timeZone
+     * @return string
+     */
+    public function setDeliveryTime($timeDate, $timeZone = null)
+    {
+        if (isset($timeZone)) {
+            $timeZoneObj = new \DateTimeZone("$timeZone");
+        } else {
+            $timeZoneObj = new \DateTimeZone(Api::DEFAULT_TIME_ZONE);
+        }
+
+        $dateTimeObj                     = new \DateTime($timeDate, $timeZoneObj);
+        $formattedTimeDate               = $dateTimeObj->format(\DateTime::RFC2822);
+        $this->message['o:deliverytime'] = $formattedTimeDate;
+
+        return $this->message['o:deliverytime'];
+    }
+
+    /**
+     * @param string $customName
+     * @param mixed $data
+     */
+    public function addCustomData($customName, $data)
+    {
+        $this->message['v:' . $customName] = json_encode($data);
+    }
+
+    /**
+     * @param string $parameterName
+     * @param mixed $data
+     * @return mixed
+     */
+    public function addCustomParameter($parameterName, $data)
+    {
+        if (isset($this->message[$parameterName])) {
+            array_push($this->message[$parameterName], $data);
+
+            return $this->message[$parameterName];
+        } else {
+            $this->message[$parameterName] = array($data);
+
+            return $this->message[$parameterName];
+        }
+    }
+
+    /**
+     * @param array $message
+     */
+    public function setMessage($message)
+    {
+        $this->message = $message;
+    }
+
+    /**
+     * @return array
+     */
+    public function getMessage()
+    {
+        return $this->message;
+    }
+
+    /**
+     * @return array
+     */
+    public function getFiles()
+    {
+        return $this->files;
+    }
+}

sites/all/libraries/mailgun/src/Mailgun/Messages/README.md

@@ -0,0 +1,138 @@
+Mailgun - Messages
+====================
+
+This is the Mailgun PHP *Message* utilities. 
+
+The below assumes you've already installed the Mailgun PHP SDK in to your 
+project. If not, go back to the master README for instructions.
+
+There are two utilities included, Message Builder and Batch Message. 
+
+Message Builder: Allows you to build a message object by calling methods for 
+each MIME attribute. 
+Batch Message: Inherits Message Builder and allows you to iterate through 
+recipients from a list. Messages will fire after the 1,000th recipient has been 
+added. 
+
+Usage - Message Builder
+-----------------------
+Here's how to use Message Builder to build your Message. 
+
+```php
+# First, instantiate the SDK with your API credentials and define your domain. 
+$mg = new Mailgun("key-example");
+$domain = "example.com";
+
+# Next, instantiate a Message Builder object from the SDK.
+$messageBldr = $mg->MessageBuilder();
+
+# Define the from address.
+$messageBldr->setFromAddress("me@example.com", array("first"=>"PHP", "last" => "SDK"));
+# Define a to recipient.
+$messageBldr->addToRecipient("john.doe@example.com", array("first" => "John", "last" => "Doe"));
+# Define a cc recipient.
+$messageBldr->addCcRecipient("sally.doe@example.com", array("first" => "Sally", "last" => "Doe"));
+# Define the subject. 
+$messageBldr->setSubject("A message from the PHP SDK using Message Builder!");
+# Define the body of the message.
+$messageBldr->setTextBody("This is the text body of the message!");
+
+# Other Optional Parameters.
+$messageBldr->addCampaignId("My-Awesome-Campaign");
+$messageBldr->addCustomHeader("Customer-Id", "12345");
+$messageBldr->addAttachment("@/tron.jpg");
+$messageBldr->setDeliveryTime("tomorrow 8:00AM", "PST");
+$messageBldr->setClickTracking(true);
+
+# Finally, send the message.
+$mg->post("{$domain}/messages", $messageBldr->getMessage(), $messageBldr->getFiles());
+```
+
+Available Functions
+-----------------------------------------------------
+
+`string addToRecipient(string $address, array $attributes)` 
+
+`string addCcRecipient(string $address, array $attributes)`  
+
+`string addBccRecipient(string $address, array $attributes)`  
+
+`string setFromAddress(string $address, array $attributes)`  
+
+`string setSubject(string $subject)`  
+
+`string setTextBody(string $textBody)`  
+
+`string setHtmlBody(string $htmlBody)`  
+
+`bool addAttachment(string $attachmentPath)`  
+
+`bool addInlineImage(string $inlineImagePath)`  
+
+`string setTestMode(bool $testMode)`  
+
+`string addCampaignId(string $campaignId)`  
+
+`string setDkim(bool $enabled)`  
+
+`string setOpenTracking($enabled)`  
+
+`string setClickTracking($enabled)`  
+
+`string setDeliveryTime(string $timeDate, string $timeZone)`  
+
+`string addCustomData(string $optionName, string $data)`  
+
+`string addCustomParameter(string $parameterName, string $data)`
+
+`array getMessage()`  
+
+`array getFiles()`  
+
+
+Usage - Batch Message
+---------------------
+Here's how to use Batch Message to easily handle batch sending jobs. 
+
+```php
+# First, instantiate the SDK with your API credentials and define your domain. 
+$mg = new Mailgun("key-example");
+$domain = "example.com";
+
+# Next, instantiate a Message Builder object from the SDK, pass in your sending 
+domain.
+$batchMsg = $mg->BatchMessage($domain);
+
+# Define the from address.
+$batchMsg->setFromAddress("me@example.com", array("first"=>"PHP", "last" => "SDK"));
+# Define the subject. 
+$batchMsg->setSubject("A Batch Message from the PHP SDK!");
+# Define the body of the message.
+$batchMsg->setTextBody("This is the text body of the message!");
+
+# Next, let's add a few recipients to the batch job.
+$batchMsg->addToRecipient("john.doe@example.com", array("first" => "John", "last" => "Doe"));
+$batchMsg->addToRecipient("sally.doe@example.com", array("first" => "Sally", "last" => "Doe"));
+$batchMsg->addToRecipient("mike.jones@example.com", array("first" => "Mike", "last" => "Jones"));
+...
+// After 1,000 recipeints, Batch Message will automatically post your message to 
+the messages endpoint. 
+
+// Call finalize() to send any remaining recipients still in the buffer.
+$batchMsg->finalize();
+
+```
+
+Available Functions (Inherits all Batch Message and Messages Functions)
+-----------------------------------------------------------------------
+
+`addToRecipient(string $address, string $attributes)`  
+
+`sendMessage(array $message, array $files)` 
+ 
+`array finalize()`  
+
+More Documentation
+------------------
+See the official [Mailgun Docs](http://documentation.mailgun.com/api-sending.html) 
+for more information.