Add new accessors to help determine whether to use the SMTPUTF8 extension

Author: arnt

src/Symfony/Component/Mailer/Envelope.php

@@ -85,4 +85,17 @@ public function getRecipients(): array
     {
         return $this->recipients;
     }
+
+    /**
+      * @return bool
+      */
+    public function anyAddressHasUnicodeLocalpart(): bool
+    {
+        if($this->sender->hasUnicodeLocalpart())
+            return true;
+        foreach($this->recipients as $r)
+            if($r->hasUnicodeLocalpart())
+                return true;
+        return false;
+    }
 }

src/Symfony/Component/Mailer/Tests/EnvelopeTest.php

@@ -127,6 +127,19 @@ public function testRecipientsFromHeaders()
         $this->assertEquals([new Address('[email protected]'), new Address('[email protected]'), new Address('[email protected]')], $e->getRecipients());
     }
 
+    public function testUnicodeLocalparts()
+    {
+        /* dømi means example and is reserved by the .fo registry */
+        $i = new Address('info@dømi.fo');
+        $d = new Address('dømi@dømi.fo');
+        $e = new Envelope($i, [$i]);
+        $this->assertFalse($e->anyAddressHasUnicodeLocalpart());
+        $e = new Envelope($i, [$d]);
+        $this->assertTrue($e->anyAddressHasUnicodeLocalpart());
+        $e = new Envelope($i, [$i, $d]);
+        $this->assertTrue($e->anyAddressHasUnicodeLocalpart());
+    }
+
     public function testRecipientsFromHeadersWithNames()
     {
         $headers = new Headers();

src/Symfony/Component/Mime/Address.php

@@ -117,4 +117,27 @@ public static function createArray(array $addresses): array
 
         return $addrs;
     }
+
+    /**
+
+      * Returns true if this address' localpart contains at least one
+      * non-ASCII character, and false if it is only ASCII (or empty).
+      *
+      * This is a helper for Envelope, which has to decide whether to
+      * the SMTPUTF8 extensions (RFC 6530 and following) for any given
+      * message.
+      *
+      * The SMTPUTF8 extension is strictly required if any address
+      * contains a non-ASCII character in its localpart. If non-ASCII
+      * is only used in domains (e.g. horst@freiherr-von-mühlhausen.de)
+      * then it is possible to to send the message using IDN encoding
+      * instead of SMTPUTF8. The most common software will display the
+      * message as intended.
+      *
+      * @return bool
+      */
+    public function hasUnicodeLocalpart(): bool
+    {
+        return (bool) preg_match( '/[\x80-\xFF].*@/', $this->address);
+    }
 }

src/Symfony/Component/Mime/Tests/AddressTest.php

@@ -81,6 +81,13 @@ public function testCreateArray()
         $this->assertEquals([$fabien], Address::createArray(['[email protected]']));
     }
 
+    public function testUnicodeLocalpart()
+    {
+        /* dømi means example and is reserved by the .fo registry */
+        $this->assertFalse((new Address('info@dømi.fo'))->hasUnicodeLocalpart());
+        $this->assertTrue((new Address('info@dømi.fo'))->hasUnicodeLocalpart());
+    }
+
     public function testCreateArrayWrongArg()
     {
         $this->expectException(\TypeError::class);