fix AddressList toString method to quote semicolon

Author: glensc

CHANGELOG.md

@@ -22,7 +22,7 @@ All notable changes to this project will be documented in this file, in reverse
 
 ### Fixed
 
-- Nothing.
+- [#230](https://github.com/zendframework/zend-mail/pull/230) Fix AddressList toString method to quote semicolon
 
 ## 2.10.0 - 2018-06-07
 

src/Header/AbstractAddressList.php

@@ -134,7 +134,9 @@ public function getFieldValue($format = HeaderInterface::FORMAT_RAW)
             $email = $address->getEmail();
             $name  = $address->getName();
 
-            if (! empty($name) && false !== strstr($name, ',')) {
+            // quote $name if value requires so
+            if (! empty($name) && (false !== strpos($name, ',') || false !== strpos($name, ';'))) {
+                // FIXME: what if name contains double quote?
                 $name = sprintf('"%s"', $name);
             }
 
@@ -240,7 +242,7 @@ protected static function getComments($value)
      * Supposed to be private, protected as a workaround for PHP bug 68194
      *
      * @param string $value
-     * @return void
+     * @return string
      */
     protected static function stripComments($value)
     {

test/Storage/MessageTest.php

@@ -10,6 +10,7 @@
 use Exception as GeneralException;
 use PHPUnit\Framework\TestCase;
 use Zend\Mail\Exception as MailException;
+use Zend\Mail\Headers;
 use Zend\Mail\Storage;
 use Zend\Mail\Storage\Exception;
 use Zend\Mail\Storage\Message;
@@ -24,6 +25,7 @@
 class MessageTest extends TestCase
 {
     protected $file;
+
     protected $file2;
 
     public function setUp()
@@ -432,6 +434,31 @@ public function testSpaceInFieldName()
         $this->assertEquals(Mime\Decode::splitHeaderField($header, 'baz'), 42);
     }
 
+    /**
+     * splitMessage with Headers as input fails to process AddressList with semicolons
+     *
+     * @see https://github.com/zendframework/zend-mail/pull/230
+     */
+    public function testHeadersLosesNameQuoting()
+    {
+        $headerList = [
+            'From: "Famous bearings |;" <[email protected]>',
+            'Reply-To: "Famous bearings |:" <[email protected]>',
+        ];
+
+        // create Headers object from array
+        Mime\Decode::splitMessage(implode("\r\n", $headerList), $headers1, $body);
+        $this->assertInstanceOf(Headers::class, $headers1);
+        // create Headers object from Headers object
+        Mime\Decode::splitMessage($headers1, $headers2, $body);
+        $this->assertInstanceOf(Headers::class, $headers2);
+
+        // test that same problem does not happen with Storage\Message internally
+        $message = new Message(['headers' => $headers2, 'content' => (string)$body]);
+        $this->assertEquals('"Famous bearings |;" <[email protected]>', $message->from);
+        $this->assertEquals('Famous bearings |: <[email protected]>', $message->replyTo);
+    }
+
     /**
      * @group ZF2-372
      */