8000 [Mailer][TwigBridge] Add support for translatable subject by norkunas · Pull Request #59967 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Mailer][TwigBridge] Add support for translatable subject #59967

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.

Sign up for GitHub

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 1 commit into from
Mar 26, 2025
Merged

[Mailer][TwigBridge] Add support for translatable subject #59967

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
[Mailer][TwigBridge] Add support for translatable subject
  • Loading branch information
@norkunas
norkunas committed Mar 26, 2025
commit 97eb49be33232745a793084dcef8f0ef4674e8e6
1 change: 1 addition & 0 deletions src/Symfony/Bridge/Twig/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ CHANGELOG

* Add `is_granted_for_user()` Twig function
* Add `field_id()` Twig form helper function
* Add `TemplatedEmail::getTranslatableSubject()` method

7.2
---
Expand Down
21 changes: 20 additions & 1 deletion src/Symfony/Bridge/Twig/Mime/TemplatedEmail.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,29 @@
*/
class TemplatedEmail extends Email
{
private string|\Stringable|null $subject = null;
private ?string $htmlTemplate = null;
private ?string $textTemplate = null;
private ?string $locale = null;
private array $context = [];

/**
* @return $this
*/
public function subject(string|\Stringable $subject): static
{
parent::subject($subject);

$this->subject = $subject;

return $this;
}

public function getTranslatableSubject(): string|\Stringable|null
{
return $this->subject;
}

/**
* @return $this
*/
Expand Down Expand Up @@ -100,7 +118,7 @@ public function markAsRendered(): void
*/
public function __serialize(): array
{
return [$this->htmlTemplate, $this->textTemplate, $this->context, parent::__serialize(), $this->locale];
return [$this->htmlTemplate, $this->textTemplate, $this->context, parent::__serialize(), $this->locale, $this->subject];
}

/**
Expand All @@ -110,6 +128,7 @@ public function __unserialize(array $data): void
{
[$this->htmlTemplate, $this->textTemplate, $this->context, $parentData] = $data;
$this->locale = $data[4] ?? null;
$this->subject = $data[5] ?? null;

parent::__unserialize($parentData);
}
Expand Down
17 changes: 17 additions & 0 deletions src/Symfony/Bridge/Twig/Tests/Mime/TemplatedEmailTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@
use Symfony\Component\Serializer\Normalizer\MimeMessageNormalizer;
use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
use Symfony\Component\Serializer\Normalizer\PropertyNormalizer;
use Symfony\Component\Serializer\Normalizer\TranslatableNormalizer;
use Symfony\Component\Serializer\Serializer;
use Symfony\Component\Translation\IdentityTranslator;
use Symfony\Component\Translation\TranslatableMessage;

class TemplatedEmailTest extends TestCase
{
Expand All @@ -44,19 +47,22 @@ public function testSerialize()
->htmlTemplate('text.html.twig')
->context($context = ['a' => 'b'])
->locale($locale = 'fr_FR')
->subject($subject = new TranslatableMessage('hello {{ name }}', ['name' => 'John'], 'greetings'))
;

$email = unserialize(serialize($email));
$this->assertEquals('text.txt.twig', $email->getTextTemplate());
$this->assertEquals('text.html.twig', $email->getHtmlTemplate());
$this->assertEquals($context, $email->getContext());
$this->assertEquals($locale, $email->getLocale());
$this->assertEquals($subject, $email->getTranslatableSubject());
}

public function testSymfonySerialize()
{
// we don't add from/sender to check that validation is not triggered to serialize an email
$e = new TemplatedEmail();
$e->subject(new TranslatableMessage('hello.world'));
$e->to('you@example.com');
$e->textTemplate('email.txt.twig');
$e->htmlTemplate('email.html.twig');
Expand All @@ -67,6 +73,7 @@ public function testSymfonySerialize()

$expectedJson = <<<EOF
{
"subject": "hello.world",
"htmlTemplate": "email.html.twig",
"textTemplate": "email.txt.twig",
"locale": "en",
Expand All @@ -84,6 +91,15 @@ public function testSymfonySerialize()
}
],
"headers": {
"subject": [
{
"value": "hello.world",
"name": "Subject",
"lineLength": 76,
"lang": null,
"charset": "utf-8"
}
],
"to": [
{
"addresses": [
Expand All @@ -108,6 +124,7 @@ public function testSymfonySerialize()
$serializer = new Serializer([
new ArrayDenormalizer(),
new MimeMessageNormalizer($propertyNormalizer),
new TranslatableNormalizer(new IdentityTranslator()),
new ObjectNormalizer(null, null, null, $extractor),
$propertyNormalizer,
], [new JsonEncoder()]);
Expand Down
6 changes: 5 additions & 1 deletion src/Symfony/Bundle/TwigBundle/Resources/config/mailer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@
return static function (ContainerConfigurator $container) {
$container->services()
->set('twig.mailer.message_listener', MessageListener::class)
->args([null, service('twig.mime_body_renderer')])
->args([
null,
service('twig.mime_body_renderer'),
'$translator' => service('translator')->ignoreOnInvalid(),
])
->tag('kernel.event_subscriber')

->set('twig.mime_body_renderer', BodyRenderer::class)
Expand Down
1 change: 1 addition & 0 deletions src/Symfony/Component/Mailer/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ CHANGELOG
* Add DSN param `source_ip` to allow binding to a (specific) IPv4 or IPv6 address.
* Add DSN param `require_tls` to enforce use of TLS/STARTTLS
* Add `DkimSignedMessageListener`, `SmimeEncryptedMessageListener`, and `SmimeSignedMessageListener`
* Add support for translatable subject in `TemplatedEmail`

7.2
---
Expand Down
16 changes: 15 additions & 1 deletion src/Symfony/Component/Mailer/EventListener/MessageListener.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@

namespace Symfony\Component\Mailer\EventListener;

use Symfony\Bridge\Twig\Mime\TemplatedEmail;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Mailer\Event\MessageEvent;
use Symfony\Component\Mailer\Exception\InvalidArgumentException;
Expand All @@ -19,9 +20,11 @@
use Symfony\Component\Mime\Header\Headers;
use Symfony\Component\Mime\Header\MailboxListHeader;
use Symfony\Component\Mime\Message;
use Symfony\Component\Translation\TranslatableMessage;
use Symfony\Contracts\Translation\TranslatorInterface;

/**
* Manipulates the headers and the body of a Message.
* Manipulates the headers, subject, and the body of a Message.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
Expand All @@ -45,6 +48,7 @@
private ?Headers $headers = null,
private ?BodyRendererInterface $renderer = null,
array $headerRules = self::DEFAULT_RULES,
private ?TranslatorInterface $translator = null,
) {
foreach ($headerRules as $headerName => $rule) {
$this->addHeaderRule($headerName, $rule);
Expand All @@ -68,6 +72,7 @@
}

$this->setHeaders($message);
$this->translateSubject($message);
$this->renderMessage($message);
}

Expand Down Expand Up @@ -115,6 +120,15 @@
}
}

private function translateSubject(Message $message): void
{
if (!$message instanceof TemplatedEmail || !$this->translator || !$message->getTranslatableSubject() instanceof TranslatableMessage) {
return;
}

$message->subject($message->getTranslatableSubject()->trans($this->translator, $message->getLocale()));

Check failure on line 129 in src/Symfony/Component/Mailer/EventListener/MessageListener.php

View workflow job for this annotation

GitHub Actions / Psalm

UndefinedInterfaceMethod 

src/Symfony/Component/Mailer/EventListener/MessageListener.php:129:63: UndefinedInterfaceMethod: Method Stringable::trans does not exist (see https://psalm.dev/181)

Check failure on line 129 in src/Symfony/Component/Mailer/EventListener/MessageListener.php

View workflow job for this annotation

GitHub Actions / Psalm

UndefinedInterfaceMethod 

src/Symfony/Component/Mailer/EventListener/MessageListener.php:129:63: UndefinedInterfaceMethod: Method Stringable::trans does not exist (see https://psalm.dev/181)
}

private function renderMessage(Message $message): void
{
if (!$this->renderer) {
Expand Down
24 changes: 24 additions & 0 deletions src/Symfony/Component/Mailer/Tests/EventListener/MessageListenerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
namespace Symfony\Component\Mailer\Tests\EventListener;

use PHPUnit\Framework\TestCase;
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mailer\Event\MessageEvent;
use Symfony\Component\Mailer\EventListener\MessageListener;
Expand All @@ -20,6 +21,8 @@
use Symfony\Component\Mime\Header\MailboxListHeader;
use Symfony\Component\Mime\Header\UnstructuredHeader;
use Symfony\Component\Mime\Message;
use Symfony\Component\Translation\TranslatableMessage;
use Symfony\Contracts\Translation\TranslatorInterface;

class MessageListenerTest extends TestCase
{
Expand Down Expand Up @@ -114,4 +117,25 @@ public static function provideHeaders(): iterable
];
yield 'Capitalized header rule (case-insensitive), replace if set' => [$initialHeaders, $defaultHeaders, $defaultHeaders, $rules];
}

public function testTranslatableSubject()
{
$message = new TemplatedEmail();
$message->subject(new TranslatableMessage('hello.world'));
$listener = new MessageListener(translator: new class implements TranslatorInterface {
public function trans(string $id, array $parameters = [], ?string $domain = null, ?string $locale = null): string
{
return 'Hello World';
}

public function getLocale(): string
{
return 'en';
}
});
$event = new MessageEvent($message, new Envelope(new Address('sender@example.com'), [new Address('recipient@example.com')]), 'smtp');
$listener->onMessage($event);

$this->assertSame('Hello World', $message->getSubject());
}
}
3 changes: 2 additions & 1 deletion src/Symfony/Component/Mailer/composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,14 @@
"psr/event-dispatcher": "^1",
"psr/log": "^1|^2|^3",
"symfony/event-dispatcher": "^6.4|^7.0",
"symfony/mime": "^7.2",
"symfony/mime": "^7.3",
"symfony/service-contracts": "^2.5|^3"
},
"require-dev": {
"symfony/console": "^6.4|^7.0",
"symfony/http-client": "^6.4|^7.0",
"symfony/messenger": "^6.4|^7.0",
"symfony/translation": "^6.4|^7.0",
"symfony/twig-bridge": "^6.4|^7.0"
},
"conflict": {
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/Mime/Email.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ class Email extends Message
/**
* @return $this
*/
public function subject(string $subject): static
public function subject(string|\Stringable $subject): static
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This may be a breaking change for apps that extend this class and override this method (https://3v4l.org/uuJj9)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Supporting a TranslatableInterface is absolutely not the same than supporting Stringable. There is no requirement for TranslatableInterface to be Stringable.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, my idea was off the cuff. Needs to be thought out more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

btw, even for the core TranslatableMessage (that is stringable), casting it to string does not translate it. It returns the translation key.

Copy link
Member
@kbond kbond Mar 26, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, I thought that'd be fine as that's the behavior of using keys that don't have a translation.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My thinking was to allow the subject to be any stringable object allowing a listener to intercept. If none does, it would just be cast to a string.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding support for Stringable and then doing weird magic to support TranslatableMessage while the changelog says it adds support for translatable subject (which would be understood as being the interface by many people) looks wrong to me (and limiting as there are valid use cases for other implementations of TranslatableInterface)

{
return $this->setHeaderBody('Text', 'Subject', $subject);
return $this->setHeaderBody('Text', 'Subject', (string) $subject);
}

public function getSubject(): ?string
Expand Down
Loading
0