Merge pull request #34 from narendravaghela/4.x-add-reply

Forward porting #33

.gitignore

@@ -4,3 +4,4 @@
 /.idea
 /.phpunit.result.cache
 /coverage
+/clover.xml

.travis.yml

@@ -31,7 +31,7 @@ before_script:
 
 script:
   - sh -c "if [ '$DEFAULT' = '1' ]; then composer test; fi"
-  - sh -c "if [ '$PHPSTAN' = '1' ]; then composer require --dev "phpstan/phpstan:^0.10" && composer phpstan; fi"
+  - sh -c "if [ '$PHPSTAN' = '1' ]; then composer require --dev "phpstan/phpstan:^0.12" && composer phpstan; fi"
   - sh -c "if [ '$PHPCS' = '1' ]; then composer cs-check; fi"
   - sh -c "if [ '$CODECOVERAGE' = '1' ]; then phpdbg -qrr vendor/bin/phpunit --coverage-clover=clover.xml || true; fi"
 

composer.json

@@ -45,7 +45,7 @@
         ],
         "cs-check": "phpcs --colors -p --standard=vendor/cakephp/cakephp-codesniffer/CakePHP src/ tests/",
         "cs-fix": "phpcbf --colors --standard=vendor/cakephp/cakephp-codesniffer/CakePHP src/ tests/",
-        "phpstan": "phpstan analyze -l 1 src/",
+        "phpstan": "phpstan analyze src/",
         "test": "phpunit --colors=always"
     }
 }

phpstan.neon

@@ -0,0 +1,8 @@
+parameters:
+    level: 7
+    checkMissingIterableValueType: false
+    autoload_files:
+        - tests/bootstrap.php
+    ignoreErrors:
+            - '#Parameter \#1 \$str of function trim expects string, array\|string given.#'
+            - '#Result of \|\| is always true.#'

src/Mailer/Transport/MailgunTransport.php

@@ -150,9 +150,9 @@ public function send(Email $email)
         if (!empty($attachments)) {
             foreach ($attachments as $fileName => $attachment) {
                 if (empty($attachment['contentId'])) {
-                    $file = $this->_addFile('attachment', $attachment, $fileName);
+                    $file = $this->_addFile('attachment', $attachment, (string)$fileName);
                 } else {
-                    $file = $this->_addFile('inline', $attachment, $fileName);
+                    $file = $this->_addFile('inline', $attachment, (string)$fileName);
                     $file->contentId($attachment['contentId']);
                 }
                 $file->disposition('attachment');
@@ -191,7 +191,7 @@ protected function _addFile($partName, $attachment, $fileName = '')
     /**
      * Returns the parameters for API request.
      *
-     * @return array
+     * @return \Cake\Http\Client\FormData
      */
     public function getRequestData()
     {
@@ -355,6 +355,10 @@ protected function _prepareEmailAddresses(Email $email)
             $this->_formData->add('from', sprintf("%s <%s>", key($from), key($from)));
         }
 
+        foreach ($email->getSender() as $toEmail => $toName) {
+            $this->_formData->add('h:Sender', sprintf("%s <%s>", $toName, $toEmail));
+        }
+
         foreach ($email->getTo() as $toEmail => $toName) {
             $this->_formData->add('to', sprintf("%s <%s>", $toName, $toEmail));
         }
@@ -366,6 +370,10 @@ protected function _prepareEmailAddresses(Email $email)
         foreach ($email->getBcc() as $bccEmail => $bccName) {
             $this->_formData->add('bcc', sprintf("%s <%s>", $bccName, $bccEmail));
         }
+
+        foreach ($email->getReplyTo() as $replyToEmail => $replyToName) {
+            $this->_formData->add('h:Reply-To', sprintf("%s <%s>", $replyToName, $replyToEmail));
+        }
     }
 
     /**

tests/TestCase/Mailer/Transport/MailgunTransportTest.php

@@ -91,11 +91,9 @@ public function testAdditionalEmailAddresses()
             ->setTo('[email protected]')
             ->addCC(['[email protected]', '[email protected]' => 'John'])
             ->addBcc(['[email protected]', '[email protected]' => 'John'])
+            ->setReplyTo(['[email protected]' => 'John'])
+            ->setSender(['[email protected]' => 'John'])
             ->setEmailFormat('both')
-            ->addHeaders([
-                'h:Reply-To' => '[email protected]',
-                'Sent-From' => '[email protected]',
-            ])
             ->setSubject('Email from CakePHP Mailgun plugin')
             ->send('Hello there, <br> This is an email from CakePHP Mailgun Email plugin.');
 
@@ -111,15 +109,15 @@ public function testAdditionalEmailAddresses()
         $this->assertTextContains('Content-Disposition: form-data; name="cc"', $reqDataString);
         $this->assertTextContains('Content-Disposition: form-data; name="bcc"', $reqDataString);
         $this->assertTextContains('Content-Disposition: form-data; name="h:Reply-To"', $reqDataString);
-        $this->assertTextContains('Content-Disposition: form-data; name="h:Sent-From"', $reqDataString);
+        $this->assertTextContains('Content-Disposition: form-data; name="h:Sender"', $reqDataString);
         $this->assertTextContains('[email protected] <[email protected]>', $reqDataString);
         $this->assertTextContains('[email protected] <[email protected]>', $reqDataString);
         $this->assertTextContains('[email protected] <[email protected]>', $reqDataString);
         $this->assertTextContains('John <[email protected]>', $reqDataString);
         $this->assertTextContains('[email protected] <[email protected]>', $reqDataString);
         $this->assertTextContains('John <[email protected]>', $reqDataString);
-        $this->assertTextContains('[email protected]', $reqDataString);
-        $this->assertTextContains('[email protected]', $reqDataString);
+        $this->assertTextContains('John <[email protected]>', $reqDataString);
+        $this->assertTextContains('John <[email protected]>', $reqDataString);
     }
 
     public function testAttachments()
@@ -145,6 +143,27 @@ public function testAttachments()
         $this->assertStringEndsWith("--$boundary--", rtrim($reqDataString));
     }
 
+    public function testCustomHeaders()
+    {
+        $this->_setEmailConfig();
+        $email = new Email();
+        $email->setProfile(['transport' => 'mailgun']);
+        $res = $email->setFrom('[email protected]')
+            ->setTo('[email protected]')
+            ->setHeaders(['h:X-MyHeader' => 'YouGotIt'])
+            ->setSubject('Email from CakePHP Mailgun plugin')
+            ->send('Hello there, <br> This is an email from CakePHP Mailgun Email plugin.');
+
+        $reqData = $res['reqData'];
+        $boundary = $reqData->boundary();
+        $reqDataString = (string)$reqData;
+
+        $this->assertNotEmpty($reqDataString);
+        $this->assertStringStartsWith("--$boundary", $reqDataString);
+        $this->assertTextContains('Content-Disposition: form-data; name="h:X-MyHeader"', $reqDataString);
+        $this->assertTextContains('YouGotIt', $reqDataString);
+    }
+
     public function testRawBinaryAttachments()
     {
         $this->_setEmailConfig();