[Mime] Fixed Mime\Message::ensureValidity() when a required header is set, but has an empty body

rhertogh · fabpot · commit dc91a0907de3 · 2024-05-29T16:27:03.000+02:00
diff --git a/src/Symfony/Component/Mime/Message.php b/src/Symfony/Component/Mime/Message.php
@@ -124,11 +124,11 @@ public function toIterable(): iterable
 
     public function ensureValidity()
     {
-        if (!$this->headers->has('To') && !$this->headers->has('Cc') && !$this->headers->has('Bcc')) {
+        if (!$this->headers->get('To')?->getBody() && !$this->headers->get('Cc')?->getBody() && !$this->headers->get('Bcc')?->getBody()) {
             throw new LogicException('An email must have a "To", "Cc", or "Bcc" header.');
         }
 
-        if (!$this->headers->has('From') && !$this->headers->has('Sender')) {
+        if (!$this->headers->get('From')?->getBody() && !$this->headers->get('Sender')?->getBody()) {
             throw new LogicException('An email must have a "From" or a "Sender" header.');
         }
 
diff --git a/src/Symfony/Component/Mime/Tests/MessageTest.php b/src/Symfony/Component/Mime/Tests/MessageTest.php
@@ -276,4 +276,71 @@ public function testSymfonySerialize()
         $serialized = $serializer->serialize($e, 'json');
         $this->assertSame($expectedJson, json_encode(json_decode($serialized), \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES));
     }
+
+    /**
+     * @dataProvider ensureValidityProvider
+     */
+    public function testEnsureValidity(array $headers, ?string $exceptionClass, ?string $exceptionMessage)
+    {
+        if ($exceptionClass) {
+            $this->expectException($exceptionClass);
+            $this->expectExceptionMessage($exceptionMessage);
+        } else {
+            $this->expectNotToPerformAssertions();
+        }
+
+        $m = new Message();
+        foreach ($headers as $headerName => $headerValue) {
+            $m->getHeaders()->addMailboxListHeader($headerName, $headerValue);
+        }
+        $m->ensureValidity();
+    }
+
+    public function ensureValidityProvider()
+    {
+        return [
+            'Valid address fields' => [
+                [
+                    'To' => ['dummy@symfony.com'],
+                    'From' => ['test@symfony.com'],
+                ],
+                null,
+                null,
+            ],
+
+            'No destination address fields' => [
+                [
+                    'From' => ['test@symfony.com'],
+                ],
+                LogicException::class,
+                'An email must have a "To", "Cc", or "Bcc" header.',
+            ],
+
+            'Empty destination address fields' => [
+                [
+                    'To' => [],
+                    'From' => ['test@symfony.com'],
+                ],
+                LogicException::class,
+                'An email must have a "To", "Cc", or "Bcc" header.',
+            ],
+
+            'No originator fields' => [
+                [
+                    'To' => ['dummy@symfony.com'],
+                ],
+                LogicException::class,
+                'An email must have a "From" or a "Sender" header.',
+            ],
+
+            'Empty originator fields' => [
+                [
+                    'To' => ['dummy@symfony.com'],
+                    'From' => [],
+                ],
+                LogicException::class,
+                'An email must have a "From" or a "Sender" header.',
+            ],
+        ];
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -124,11 +124,11 @@ public function toIterable(): iterable`
`124`	`124`
`125`	`125`	`public function ensureValidity()`
`126`	`126`	`{`
`127`		`- if (!$this->headers->has('To') && !$this->headers->has('Cc') && !$this->headers->has('Bcc')) {`
	`127`	`+ if (!$this->headers->get('To')?->getBody() && !$this->headers->get('Cc')?->getBody() && !$this->headers->get('Bcc')?->getBody()) {`
`128`	`128`	`throw new LogicException('An email must have a "To", "Cc", or "Bcc" header.');`
`129`	`129`	`}`
`130`	`130`
`131`		`- if (!$this->headers->has('From') && !$this->headers->has('Sender')) {`
	`131`	`+ if (!$this->headers->get('From')?->getBody() && !$this->headers->get('Sender')?->getBody()) {`
`132`	`132`	`throw new LogicException('An email must have a "From" or a "Sender" header.');`
`133`	`133`	`}`
`134`	`134`