bug #33216 [Mime] Trim and remove line breaks from NamedAddress name arg (maldoinc)

fabpot · fabpot · commit 58439e3166f5 · 2019-08-21T10:46:47.000+02:00
This PR was squashed before being merged into the 4.3 branch (closes #33216). Discussion ---------- [Mime] Trim and remove line breaks from NamedAddress name arg | Q | A | ------------- | --- | Branch? | 4.3 | Bug fix? | YES | New feature? | NO | BC breaks? | NO  | Deprecations? | NO  | Tests pass? | YES  | Fixed tickets | N/A  | License | MIT | Doc PR | N/A This patch trims the name argument of named address in order to avoid some cases where the name is a non-empty input consisting of whitespace and line breaks which would lead to forming of addresses such as `" " <mail@example.org>` <sup>1</sup> --- In a large Symfony codebase that deals with sending large volumes of email we encountered an issue after the Mailer was changed from PHPMailer to the Symfony Mailer component. The issue: Some emails would not render correctly as either plaintext or html but instead the original email source with headers and quoted-printable content would render in clients such as MS Outlook 2003, later versions of Outlook and other clients do not seem affected. After some investigation we found that the error came from a line that looked like this: `$message->addTo(new NamedAddress($contact->getEmailCanonical(), $contact->getFullName()))`. The `getFullName` method simply concated the first/last name with a space in between. For contacts without either, this resulted in representation 1. This causes MS Outlook 2003 (potentially Outlook 2000 as well but this was not tested) to malfunction and completely fail to render the email. This patch aims to fix the aforementioned issue. Commits ------- e491e3a [Mime] Trim and remove line breaks from NamedAddress name arg
diff --git a/src/Symfony/Component/Mime/Address.php b/src/Symfony/Component/Mime/Address.php
@@ -40,11 +40,11 @@ public function __construct(string $address)
             self::$validator = new EmailValidator();
         }
 
-        if (!self::$validator->isValid($address, new RFCValidation())) {
+        $this->address = trim($address);
+
+        if (!self::$validator->isValid($this->address, new RFCValidation())) {
             throw new RfcComplianceException(sprintf('Email "%s" does not comply with addr-spec of RFC 2822.', $address));
         }
-
-        $this->address = $address;
     }
 
     public function getAddress(): string
diff --git a/src/Symfony/Component/Mime/NamedAddress.php b/src/Symfony/Component/Mime/NamedAddress.php
@@ -24,7 +24,7 @@ public function __construct(string $address, string $name)
     {
         parent::__construct($address);
 
-        $this->name = $name;
+        $this->name = trim(str_replace(["\n", "\r"], '', $name));
     }
 
     public function getName(): string
diff --git a/src/Symfony/Component/Mime/Tests/NamedAddressTest.php b/src/Symfony/Component/Mime/Tests/NamedAddressTest.php
@@ -24,4 +24,19 @@ public function testConstructor()
         $this->assertEquals('Fabien <fabien@xn--symfon-nwa.com>', $a->toString());
         $this->assertEquals('fabien@xn--symfon-nwa.com', $a->getEncodedAddress());
     }
+
+    public function nameEmptyDataProvider(): array
+    {
+        return [[''], [' '], [" \r\n "]];
+    }
+
+    /**
+     * @dataProvider nameEmptyDataProvider
+     */
+    public function testNameEmpty(string $name)
+    {
+        $mail = 'mail@example.org';
+
+        $this->assertSame($mail, (new NamedAddress($mail, $name))->getEncodedNamedAddress());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -40,11 +40,11 @@ public function __construct(string $address)`
`40`	`40`	`self::$validator = new EmailValidator();`
`41`	`41`	`}`
`42`	`42`
`43`		`- if (!self::$validator->isValid($address, new RFCValidation())) {`
	`43`	`+ $this->address = trim($address);`
	`44`	`+`
	`45`	`+ if (!self::$validator->isValid($this->address, new RFCValidation())) {`
`44`	`46`	`throw new RfcComplianceException(sprintf('Email "%s" does not comply with addr-spec of RFC 2822.', $address));`
`45`	`47`	`}`
`46`		`-`
`47`		`- $this->address = $address;`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`public function getAddress(): string`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ public function __construct(string $address, string $name)`
`24`	`24`	`{`
`25`	`25`	`parent::__construct($address);`
`26`	`26`
`27`		`- $this->name = $name;`
	`27`	`+ $this->name = trim(str_replace(["\n", "\r"], '', $name));`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`public function getName(): string`