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 146f260

Browse filesBrowse files
fabpotfabpot
committed
[Mailer] fixed the possibility to set a From header from MessageListener
1 parent 6c93002 commit 146f260
Copy full SHA for 146f260

File tree

4 files changed

+112
-42
lines changed
Filter options

4 files changed

+112
-42
lines changed

‎src/Symfony/Component/Mailer/DelayedSmtpEnvelope.php

Copy file name to clipboard
+105Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\Mailer;
13+
14+
use Symfony\Component\Mailer\Exception\InvalidArgumentException;
15+
use Symfony\Component\Mailer\Exception\LogicException;
16+
use Symfony\Component\Mime\Address;
17+
use Symfony\Component\Mime\Header\Headers;
18+
use Symfony\Component\Mime\Message;
19+
use Symfony\Component\Mime\RawMessage;
20+
21+
/**
22+
* @author Fabien Potencier <fabien@symfony.com>
23+
*
24+
* @experimental in 4.3
25+
*
26+
* @internal
27+
*/
28+
final class DelayedSmtpEnvelope extends SmtpEnvelope
29+
{
30+
private $senderSet;
31+
private $recipientsSet;
32+
private $message;
33+
34+
public function __construct(RawMessage $message)
35+
{
36+
if (!$message instanceof Message) {
37+
// FIXME: parse the raw message to create the envelope?
38+
throw new InvalidArgumentException(sprintf('Unable to create an SmtpEnvelope from a "%s" message.', RawMessage::class));
39+
}
40+
41+
$this->message = $message;
42+
}
43+
44+
public function setSender(Address $sender): void
45+
{
46+
parent::setSender($sender);
47+
48+
$this->senderSet = true;
49+
}
50+
51+
public function getSender(): Address
52+
{
53+
if ($this->senderSet) {
54+
return parent::getSender();
55+
}
56+
57+
return self::getSenderFromHeaders($this->message->getHeaders());
58+
}
59+
60+
public function setRecipients(array $recipients): void
61+
{
62+
parent::setRecipients($recipients);
63+
64+
$this->recipientsSet = parent::getRecipients();
65+
}
66+
67+
/**
68+
* @return Address[]
69+
*/
70+
public function getRecipients(): array
71+
{
72+
if ($this->recipientsSet) {
73+
return parent::getRecipients();
74+
}
75+
76+
return self::getRecipientsFromHeaders($this->message->getHeaders());
77+
}
78+
79+
private static function getRecipientsFromHeaders(Headers $headers): array
80+
{
81+
$recipients = [];
82+
foreach (['to', 'cc', 'bcc'] as $name) {
83+
foreach ($headers->getAll($name) as $header) {
84+
$recipients = array_merge($recipients, $header->getAddresses());
85+
}
86+
}
87+
88+
return $recipients;
89+
}
90+
91+
private static function getSenderFromHeaders(Headers $headers): Address
92+
{
93+
if ($return = $headers->get('Return-Path')) {
94+
return $return->getAddress();
95+
}
96+
if ($sender = $headers->get('Sender')) {
97+
return $sender->getAddress();
98+
}
99+
if ($from = $headers->get('From')) {
100+
return $from->getAddresses()[0];
101+
}
102+
103+
throw new LogicException('Unable to determine the sender of the message.');
104+
}
105+
}

‎src/Symfony/Component/Mailer/SmtpEnvelope.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Mailer/SmtpEnvelope.php
+1-38Lines changed: 1 addition & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,7 @@
1212
namespace Symfony\Component\Mailer;
1313

1414
use Symfony\Component\Mailer\Exception\InvalidArgumentException;
15-
use Symfony\Component\Mailer\Exception\LogicException;
1615
use Symfony\Component\Mime\Address;
17-
use Symfony\Component\Mime\Header\Headers;
18-
use Symfony\Component\Mime\Message;
1916
use Symfony\Component\Mime\NamedAddress;
2017
use Symfony\Component\Mime\RawMessage;
2118

@@ -40,14 +37,7 @@ public function __construct(Address $sender, array $recipients)
4037

4138
public static function create(RawMessage $message): self
4239
{
43-
if ($message instanceof Message) {
44-
$headers = $message->getHeaders();
45-
46-
return new self(self::getSenderFromHeaders($headers), self::getRecipientsFromHeaders($headers));
47-
}
48-
49-
// FIXME: parse the raw message to create the envelope?
50-
throw new InvalidArgumentException(sprintf('Unable to create an SmtpEnvelope from a "%s" message.', RawMessage::class));
40+
return new DelayedSmtpEnvelope($message);
5141
}
5242

5343
public function setSender(Address $sender): void
@@ -84,31 +74,4 @@ public function getRecipients(): array
8474
{
8575
return $this->recipients;
8676
}
87-
88-
private static function getRecipientsFromHeaders(Headers $headers): array
89-
{
90-
$recipients = [];
91-
foreach (['to', 'cc', 'bcc'] as $name) {
92-
foreach ($headers->getAll($name) as $header) {
93-
$recipients = array_merge($recipients, $header->getAddresses());
94-
}
95-
}
96-
97-
return $recipients;
98-
}
99-
100-
private static function getSenderFromHeaders(Headers $headers): Address
101-
{
102-
if ($return = $headers->get('Return-Path')) {
103-
return $return->getAddress();
104-
}
105-
if ($sender = $headers->get('Sender')) {
106-
return $sender->getAddress();
107-
}
108-
if ($from = $headers->get('From')) {
109-
return $from->getAddresses()[0];
110-
}
111-
112-
throw new LogicException('Unable to determine the sender of the message.');
113-
}
11477
}

‎src/Symfony/Component/Mailer/Tests/SmtpEnvelopeTest.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Mailer/Tests/SmtpEnvelopeTest.php
+4-3Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,13 @@ public function testSenderFromHeaders()
7272
$this->assertEquals('from@symfony.com', $e->getSender()->getAddress());
7373
}
7474

75-
public function testSenderFromHeadersWithoutData()
75+
public function testSenderFromHeadersWithoutFrom()
7676
{
77-
$this->expectException(\LogicException::class);
7877
$headers = new Headers();
7978
$headers->addMailboxListHeader('To', ['from@symfony.com']);
80-
SmtpEnvelope::create(new Message($headers));
79+
$e = SmtpEnvelope::create($message = new Message($headers));
80+
$message->getHeaders()->addMailboxListHeader('From', ['from@symfony.com']);
81+
$this->assertEquals('from@symfony.com', $e->getSender()->getAddress());
8182
}
8283

8384
public function testRecipientsFromHeaders()

‎src/Symfony/Component/Mailer/Transport/AbstractTransport.php

Copy file name to clipboardExpand all lines: src/Symfony/Component/Mailer/Transport/AbstractTransport.php
+2-1Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
use Psr\Log\NullLogger;
1616
use Symfony\Component\EventDispatcher\EventDispatcher;
1717
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
18+
use Symfony\Component\Mailer\DelayedSmtpEnvelope;
1819
use Symfony\Component\Mailer\Event\MessageEvent;
1920
use Symfony\Component\Mailer\Exception\TransportException;
2021
use Symfony\Component\Mailer\SentMessage;
@@ -62,7 +63,7 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
6263
$envelope = clone $envelope;
6364
} else {
6465
try {
65-
$envelope = SmtpEnvelope::create($message);
66+
$envelope = new DelayedSmtpEnvelope($message);
6667
} catch (\Exception $e) {
6768
throw new TransportException('Cannot send message without a valid envelope.', 0, $e);
6869
}

0 commit comments

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