-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[FrameworkBundle][Mailer] Add a way to configure some email headers from semantic configuration #36736
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
[FrameworkBundle][Mailer] Add a way to configure some email headers from semantic configuration #36736
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
105 changes: 105 additions & 0 deletions
105
src/Symfony/Component/Mailer/Tests/EventListener/MessageListenerTest.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,105 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Component\Mailer\Tests; | ||
|
||
use PHPUnit\Framework\TestCase; | ||
use Symfony\Component\Mailer\Envelope; | ||
use Symfony\Component\Mailer\Event\MessageEvent; | ||
use Symfony\Component\Mailer\EventListener\MessageListener; | ||
use Symfony\Component\Mime\Address; | ||
use Symfony\Component\Mime\Header\Headers; | ||
use Symfony\Component\Mime\Header\MailboxListHeader; | ||
use Symfony\Component\Mime\Header\UnstructuredHeader; | ||
use Symfony\Component\Mime\Message; | ||
|
||
class MessageListenerTest extends TestCase | ||
{ | ||
/** | ||
* @dataProvider provideHeaders | ||
*/ | ||
public function testHeaders(Headers $initialHeaders, Headers $defaultHeaders, Headers $expectedHeaders, array $rules = MessageListene F438 r::DEFAULT_RULES) | ||
{ | ||
$message = new Message($initialHeaders); | ||
$listener = new MessageListener($defaultHeaders, null, $rules); | ||
$event = new MessageEvent($message, new Envelope(new Address('sender@example.com'), [new Address('recipient@example.com')]), 'smtp'); | ||
$listener->onMessage($event); | ||
|
||
$this->assertEquals($expectedHeaders, $event->getMessage()->getHeaders()); | ||
} | ||
|
||
public function provideHeaders(): iterable | ||
{ | ||
$initialHeaders = new Headers(); | ||
$defaultHeaders = (new Headers()) | ||
->add(new MailboxListHeader('from', [new Address('from-default@example.com')])) | ||
; | ||
yield 'No defaults, all headers copied over' => [$initialHeaders, $defaultHeaders, $defaultHeaders]; | ||
|
||
$initialHeaders = new Headers(); | ||
$defaultHeaders = (new Headers()) | ||
->add(new UnstructuredHeader('foo', 'bar')) | ||
->add(new UnstructuredHeader('bar', 'foo')) | ||
; | ||
yield 'No defaults, default is to set if empty' => [$initialHeaders, $defaultHeaders, $defaultHeaders]; | ||
|
||
$initialHeaders = (new Headers()) | ||
->add(new UnstructuredHeader('foo', 'initial')) | ||
; | ||
$defaultHeaders = (new Headers()) | ||
->add(new UnstructuredHeader('foo', 'bar')) | ||
->add(new UnstructuredHeader('bar', 'foo')) | ||
; | ||
$expectedHeaders = (new Headers()) | ||
->add(new UnstructuredHeader('foo', 'initial')) | ||
->add(new UnstructuredHeader('bar', 'foo')) | ||
; | ||
yield 'Some defaults, default is to set if empty' => [$initialHeaders, $defaultHeaders, $expectedHeaders]; | ||
|
||
$initialHeaders = (new Headers()) | ||
->add(new UnstructuredHeader('foo', 'initial')) | ||
; | ||
$defaultHeaders = (new Headers()) | ||
->add(new UnstructuredHeader('foo', 'bar')) | ||
->add(new UnstructuredHeader('bar', 'foo')) | ||
; | ||
$rules = [ | ||
'foo' => MessageListener::HEADER_REPLACE, | ||
]; | ||
yield 'Some defaults, replace if set' => [$initialHeaders, $defaultHeaders, $defaultHeaders, $rules]; | ||
|
||
$initialHeaders = (new Headers()) | ||
->add(new UnstructuredHeader('foo', 'bar')) | ||
; | ||
$defaultHeaders = (new Headers()) | ||
->add(new UnstructuredHeader('foo', 'foo')) | ||
; | ||
$expectedHeaders = (new Headers()) | ||
->add(new UnstructuredHeader('foo', 'bar')) | ||
->add(new UnstructuredHeader('foo', 'foo')) | ||
; | ||
$rules = [ | ||
'foo' => MessageListener::HEADER_ADD, | ||
]; | ||
yield 'Some defaults, add if set (not unique header)' => [$initialHeaders, $defaultHeaders, $expectedHeaders, $rules]; | ||
|
||
$initialHeaders = (new Headers()) | ||
->add(new MailboxListHeader('bcc', [new Address('bcc-initial@example.com')])) | ||
; | ||
$defaultHeaders = (new Headers()) | ||
->add(new MailboxListHeader('bcc', [new Address('bcc-default@example.com'), new Address('bcc-default-1@example.com')])) | ||
; | ||
$expectedHeaders = (new Headers()) | ||
->add(new MailboxListHeader('bcc', [new Address('bcc-initial@example.com'), new Address('bcc-default@example.com'), new Address('bcc-default-1@example.com')])) | ||
; | ||
yield 'bcc, add another bcc (unique header)' => [$initialHeaders, $defaultHeaders, $expectedHeaders]; | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.