Added the dry run mode for sendMessage()

Author: baibaratsky

MailgunApi.php

@@ -16,6 +16,8 @@ class MailgunApi
     private $_clicksTrackingMode;
     private $_enableOpensTracking;
 
+    private $_enableDryRun = false;
+
     private $_domain;
     private $_key;
 
@@ -50,6 +52,10 @@ public function newMessage()
      */
     public function sendMessage(MailgunMessage $message)
     {
+        if ($this->_enableDryRun) {
+            return '';
+        }
+
         $response = $this->_performRequest('POST', $this->_url . $this->_domain . '/messages', $message);
         return $response['id'];
     }
@@ -107,7 +113,7 @@ public function updateMailingList($listAddress, MailgunList $mailingList)
     public function deleteMailingList($listAddress)
     {
         $response = $this->_performRequest('DELETE', $this->_url . 'lists/' . $listAddress);
-        return $response['message'] == 'Mailing list has been deleted';
+        return $response['message'] === 'Mailing list has been deleted';
     }
 
     /**
@@ -161,7 +167,7 @@ public function addMemberToMailingList($listAddress, MailgunListMember $member,
      */
     public function addMultipleMembersToMailingList($listAddress, $members)
     {
-        if (count($members) == 0) {
+        if (count($members) === 0) {
             throw new MailgunException('The members list is empty.');
         }
 
@@ -206,7 +212,7 @@ public function deleteMailingListMember($listAddress, $memberAddress)
     {
         $response = $this->_performRequest('DELETE', $this->_url . 'lists/' . $listAddress
                                                                  . '/members/' . $memberAddress);
-        return $response['message'] == 'Mailing list member has been deleted';
+        return $response['message'] === 'Mailing list member has been deleted';
     }
 
     /**
@@ -256,7 +262,7 @@ public function getUserUnsubscribes($userAddress)
     public function createUnsubscribe(MailgunUnsubscribe $unsubscribe)
     {
         $response = $this->_performRequest('POST', $this->_url . $this->_domain . '/unsubscribes', $unsubscribe);
-        return $response['message'] == 'Address has been added to the unsubscribes table';
+        return $response['message'] === 'Address has been added to the unsubscribes table';
     }
 
     /**
@@ -266,7 +272,7 @@ public function createUnsubscribe(MailgunUnsubscribe $unsubscribe)
     public function deleteUnsubscribe($id)
     {
         $response = $this->_performRequest('DELETE', $this->_url . $this->_domain . '/unsubscribes/' . $id);
-        return $response['message'] == 'Unsubscribe event has been removed';
+        return $response['message'] === 'Unsubscribe event has been removed';
     }
 
     /**
@@ -276,7 +282,7 @@ public function deleteUnsubscribe($id)
     public function deleteUserUnsubscribes($userAddress)
     {
         $response = $this->_performRequest('DELETE', $this->_url . $this->_domain . '/unsubscribes/' . $userAddress);
-        return $response['message'] == 'Unsubscribe event has been removed';
+        return $response['message'] === 'Unsubscribe event has been removed';
     }
 
     /**
@@ -312,7 +318,7 @@ public function getComplaint($userAddress)
     public function createComplaint(MailgunComplaint $complaint)
     {
         $response = $this->_performRequest('POST', $this->_url . $this->_domain . '/complaints', $complaint);
-        return $response['message'] == 'Address has been added to the complaints table';
+        return $response['message'] === 'Address has been added to the complaints table';
     }
 
     /**
@@ -322,7 +328,7 @@ public function createComplaint(MailgunComplaint $complaint)
     public function deleteComplaint($userAddress)
     {
         $response = $this->_performRequest('DELETE', $this->_url . $this->_domain . '/complaints/' . $userAddress);
-        return $response['message'] == 'Spam complaint has been removed';
+        return $response['message'] === 'Spam complaint has been removed';
     }
 
     /**
@@ -358,7 +364,7 @@ public function getBounce($userAddress)
     public function createBounce(MailgunBounce $bounce)
     {
         $response = $this->_performRequest('POST', $this->_url . $this->_domain . '/bounces', $bounce);
-        return $response['message'] == 'Address has been added to the bounces table';
+        return $response['message'] === 'Address has been added to the bounces table';
     }
 
     /**
@@ -368,7 +374,7 @@ public function createBounce(MailgunBounce $bounce)
     public function deleteBounce($userAddress)
     {
         $response = $this->_performRequest('DELETE', $this->_url . $this->_domain . '/bounces/' . $userAddress);
-        return $response['message'] == 'Bounced address has been removed';
+        return $response['message'] === 'Bounced address has been removed';
     }
 
     /**
@@ -424,7 +430,7 @@ public function updateRoute($id, MailgunRoute $route)
     public function deleteRoute($id)
     {
         $response = $this->_performRequest('DELETE', $this->_url . 'routes/' . $id);
-        return $response['message'] == 'Route has been deleted';
+        return $response['message'] === 'Route has been deleted';
     }
 
     /**
@@ -587,6 +593,28 @@ public function getIsOpensTrackingEnabled()
         return $this->_enableOpensTracking;
     }
 
+    /**
+     * You can use dry run to test your code without making real API requests
+     * Affects only sendMessage()!
+     */
+    public function enableDryRun()
+    {
+        $this->_enableDryRun = true;
+    }
+
+    public function disableDryRun()
+    {
+        $this->_enableDryRun = false;
+    }
+
+    /**
+     * @return bool
+     */
+    public function getIsDryRunEnabled()
+    {
+        return $this->_enableDryRun;
+    }
+
     /**
      * @return resource cURL instance
      */
@@ -636,7 +664,7 @@ protected function _performRequest($method, $url, MailgunObject $object = null,
             throw new MailgunException('Mailgun server error', $responseStatus);
         } else {
             $responseArray = json_decode($response, true);
-            if ($responseStatus == 200) {
+            if ($responseStatus === 200) {
                 return $responseArray;
             } else {
                 throw new MailgunException(!empty($responseArray['message']) ? $responseArray['message'] : $response,

MailgunRoute.php

@@ -159,7 +159,7 @@ public function addStopAction()
     public function removeAction($action)
     {
         foreach ($this->_actions as $key => $value) {
-            if ($value == $action) {
+            if ($value === $action) {
                 unset($this->_actions[$key]);
             }
         }

MailgunYii.php

@@ -76,6 +76,8 @@ class MailgunYii extends CApplicationComponent
     public $clicksTrackingMode;
     public $enableOpensTracking;
 
+    public $enableDryRun;
+
     protected $_api;
 
     public function __call($name, $parameters)
@@ -114,6 +116,9 @@ public function init()
         if (isset($this->enableOpensTracking)) {
             $this->enableOpensTracking ? $this->_api->enableOpensTracking() : $this->_api->disableOpensTracking();
         }
+        if (isset($this->enableDryRun)) {
+            $this->enableDryRun ? $this->_api->enableDryRun() : $this->_api->disableDryRun();
+        }
     }
 
     /**

MailgunYii2.php

@@ -76,6 +76,8 @@ class MailgunYii2 extends \yii\base\Component
     public $clicksTrackingMode;
     public $enableOpensTracking;
 
+    public $enableDryRun;
+
     protected $_api;
 
     public function __call($name, $parameters)
@@ -115,6 +117,9 @@ public function init()
         if (isset($this->enableOpensTracking)) {
             $this->enableOpensTracking ? $this->_api->enableOpensTracking() : $this->_api->disableOpensTracking();
         }
+        if (isset($this->enableDryRun)) {
+            $this->enableDryRun ? $this->_api->enableDryRun() : $this->_api->disableDryRun();
+        }
     }
 
     /**

README.md

@@ -18,7 +18,7 @@ The library requires PHP 5.2 compiled with [cURL extension](http://www.php.net/m
 0. Add php-mailgun dependency:
 
     ```
-    php composer.phar require baibaratsky/php-mailgun:1.1.*
+    php composer.phar require baibaratsky/php-mailgun:1.2.*
     ```
 
 
@@ -39,6 +39,9 @@ $message->addTag('test'); // All the Mailgun-specific attributes, such as tags,
 
 $message->enableTestMode(); // Don’t forget to remove this string if you really want the message to be sent
 
+// You can also use dry run to test your code without making real API requests (only for sendMessage())
+// $mailgun->enableDryRun();
+
 echo $message->send();
 ```