Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit f3cf7e0

Browse filesBrowse files
fabpotfabpot
committed
bug #53565 [Mime] Fix undefined array key 0 when empty sender (0x346e3730)
This PR was squashed before being merged into the 5.4 branch. Discussion ---------- [Mime] Fix undefined array key 0 when empty sender | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | yes | New feature? | no | Deprecations? | no | Issues | N/A | License | MIT Today I managed to produce the following error : ![image](https://github.com/symfony/symfony/assets/28731165/11b3b76d-d220-4f08-9b12-838ca936f540) From the following code : ```php $email = (new TemplatedEmail()) ->from() ->to($member->getEmail()) ->subject('Adhésion Sauvade') ->htmlTemplate('emails/new-membership/index.html.twig') ->context([ 'member' => $member, ]) ->addPart(new DataPart( $this->pdfService->generatePdfFromTemplate( 'emails/new-membership/attachments/recu.html.twig', ['member' => $member] ), )) ->addPart(new DataPart( $this->pdfService->generatePdfFromTemplate( 'emails/new-membership/attachments/membership-card.html.twig', ['member' => $member] ), )) ; $this->mailer->send($email); ``` This happens because the `from` method from the `Symfony\Component\Mime\Email` class adds the header even if the array of addresses is empty. I identified two ways of fixing this : - Adding a check in the `Symfony\Component\Mime\Message` class before accessing the key 0 and throw a better exception in case the adresses are empty - Modifying the `from` method so that it doesn't add the header if the adresses are empty; or throw an exception when trying to do so. I'm unsure what method is the cleaner, I thought that fixing the Message access of an undefined key was the widest fix (as I guess it could happen from somewhere else than the Mailer component). Also not sure how to test that and wanted to make sure this fix was good before testing it. Commits ------- ee49a78 [Mime] Fix undefined array key 0 when empty sender
2 parents e34d994 + ee49a78 commit f3cf7e0
Copy full SHA for f3cf7e0

File tree

4 files changed

+25
-1
lines changed
Filter options

4 files changed

+25
-1
lines changed

‎src/Symfony/Component/Mime/Email.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Mime/Email.php
+4Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,10 @@ public function addFrom(...$addresses)
121121
*/
122122
public function from(...$addresses)
123123
{
124+
if (!$addresses) {
125+
throw new LogicException('"from()" must be called with at least one address.');
126+
}
127+
124128
return $this->setListAddressHeaderBody('From', $addresses);
125129
}
126130

‎src/Symfony/Component/Mime/Message.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Mime/Message.php
+4-1Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,10 @@ public function generateMessageId(): string
140140
if ($this->headers->has('Sender')) {
141141
$sender = $this->headers->get('Sender')->getAddress();
142142
} elseif ($this->headers->has('From')) {
143-
$sender = $this->headers->get('From')->getAddresses()[0];
143+
if (!$froms = $this->headers->get('From')->getAddresses()) {
144+
throw new LogicException('A "From" header must have at least one email address.');
145+
}
146+
$sender = $froms[0];
144147
} else {
145148
throw new LogicException('An email must have a "From" or a "Sender" header.');
146149
}

‎src/Symfony/Component/Mime/Tests/EmailTest.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Mime/Tests/EmailTest.php
+8Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
use PHPUnit\Framework\TestCase;
1616
use Symfony\Component\Mime\Address;
1717
use Symfony\Component\Mime\Email;
18+
use Symfony\Component\Mime\Exception\LogicException;
1819
use Symfony\Component\Mime\Part\DataPart;
1920
use Symfony\Component\Mime\Part\Multipart\AlternativePart;
2021
use Symfony\Component\Mime\Part\Multipart\MixedPart;
@@ -62,6 +63,13 @@ public function testSender()
6263
$this->assertSame($fabien, $e->getSender());
6364
}
6465

66+
public function testFromWithNoAddress()
67+
{
68+
$e = new Email();
69+
$this->expectException(LogicException::class);
70+
$e->from();
71+
}
72+
6573
public function testFrom()
6674
{
6775
$e = new Email();

‎src/Symfony/Component/Mime/Tests/MessageTest.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Mime/Tests/MessageTest.php
+9Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
use PHPUnit\Framework\TestCase;
1515
use Symfony\Component\Mime\Address;
16+
use Symfony\Component\Mime\Exception\LogicException;
1617
use Symfony\Component\Mime\Header\Headers;
1718
use Symfony\Component\Mime\Header\MailboxListHeader;
1819
use Symfony\Component\Mime\Header\UnstructuredHeader;
@@ -125,6 +126,14 @@ public function testGetPreparedHeadersHasSenderWhenNeeded()
125126
$this->assertEquals('thomas@symfony.com', $message->getPreparedHeaders()->get('Sender')->getAddress()->getAddress());
126127
}
127128

129+
public function testGenerateMessageIdThrowsWhenHasFromButNoAddresses()
130+
{
131+
$message = new Message();
132+
$message->getHeaders()->addMailboxListHeader('From', []);
133+
$this->expectException(LogicException::class);
134+
$message->generateMessageId();
135+
}
136+
128137
public function testToString()
129138
{
130139
$message = new Message();

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.