[Mailer][TwigBridge] Add support for translatable subject

norkunas · norkunas · commit a9b69b44af98 · 2025-03-13T10:30:23.000+02:00
diff --git a/src/Symfony/Bridge/Twig/CHANGELOG.md b/src/Symfony/Bridge/Twig/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Add `is_granted_for_user()` Twig function
  * Add `field_id()` Twig form helper function
+ * Add `TemplatedEmail::translatableSubject` method
 
 7.2
 ---
diff --git a/src/Symfony/Bridge/Twig/Mime/TemplatedEmail.php b/src/Symfony/Bridge/Twig/Mime/TemplatedEmail.php
@@ -12,6 +12,7 @@
 namespace Symfony\Bridge\Twig\Mime;
 
 use Symfony\Component\Mime\Email;
+use Symfony\Contracts\Translation\TranslatableInterface;
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
@@ -22,6 +23,7 @@ class TemplatedEmail extends Email
     private ?string $textTemplate = null;
     private ?string $locale = null;
     private array $context = [];
+    private ?TranslatableInterface $translatableSubject = null;
 
     /**
      * @return $this
@@ -83,6 +85,21 @@ public function getContext(): array
         return $this->context;
     }
 
+    /**
+     * @return $this
+     */
+    public function translatableSubject(TranslatableInterface $subject): static
+    {
+        $this->translatableSubject = $subject;
+
+        return $this;
+    }
+
+    public function getTranslatableSubject():  ?TranslatableInterface
+    {
+        return $this->translatableSubject;
+    }
+
     public function isRendered(): bool
     {
         return null === $this->htmlTemplate && null === $this->textTemplate;
@@ -100,7 +117,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->translatableSubject];
     }
 
     /**
@@ -110,6 +127,7 @@ public function __unserialize(array $data): void
     {
         [$this->htmlTemplate, $this->textTemplate, $this->context, $parentData] = $data;
         $this->locale = $data[4] ?? null;
+        $this->translatableSubject = $data[5] ?? null;
 
         parent::__unserialize($parentData);
     }
diff --git a/src/Symfony/Bridge/Twig/Tests/Mime/TemplatedEmailTest.php b/src/Symfony/Bridge/Twig/Tests/Mime/TemplatedEmailTest.php
@@ -21,6 +21,7 @@
 use Symfony\Component\Serializer\Normalizer\ObjectNormalizer;
 use Symfony\Component\Serializer\Normalizer\PropertyNormalizer;
 use Symfony\Component\Serializer\Serializer;
+use Symfony\Component\Translation\TranslatableMessage;
 
 class TemplatedEmailTest extends TestCase
 {
@@ -44,13 +45,15 @@ public function testSerialize()
             ->htmlTemplate('text.html.twig')
             ->context($context = ['a' => 'b'])
             ->locale($locale = 'fr_FR')
+            ->translatableSubject($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()
@@ -73,6 +76,7 @@ public function testSymfonySerialize()
     "context": {
         "foo": "bar"
     },
+    "translatableSubject": null,
     "text": null,
     "textCharset": null,
     "html": null,
diff --git a/src/Symfony/Bundle/TwigBundle/Resources/config/mailer.php b/src/Symfony/Bundle/TwigBundle/Resources/config/mailer.php
@@ -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)
diff --git a/src/Symfony/Component/Mailer/CHANGELOG.md b/src/Symfony/Component/Mailer/CHANGELOG.md
@@ -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
 
 7.2
 ---
diff --git a/src/Symfony/Component/Mailer/EventListener/MessageListener.php b/src/Symfony/Component/Mailer/EventListener/MessageListener.php
@@ -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;
@@ -19,9 +20,10 @@
 use Symfony\Component\Mime\Header\Headers;
 use Symfony\Component\Mime\Header\MailboxListHeader;
 use Symfony\Component\Mime\Message;
+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>
  */
@@ -45,6 +47,7 @@ public function __construct(
         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);
@@ -68,6 +71,7 @@ public function onMessage(MessageEvent $event): void
         }
 
         $this->setHeaders($message);
+        $this->translateSubject($message);
         $this->renderMessage($message);
     }
 
@@ -115,6 +119,15 @@ private function setHeaders(Message $message): void
         }
     }
 
+    private function translateSubject(Message $message): void
+    {
+        if (!$message instanceof TemplatedEmail || !$this->translator || !$message->getTranslatableSubject()) {
+            return;
+        }
+
+        $message->subject($message->getTranslatableSubject()->trans($this->translator, $message->getLocale()));
+    }
+
     private function renderMessage(Message $message): void
     {
         if (!$this->renderer) {
diff --git a/src/Symfony/Component/Mailer/Tests/EventListener/MessageListenerTest.php b/src/Symfony/Component/Mailer/Tests/EventListener/MessageListenerTest.php
@@ -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;
@@ -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\IdentityTranslator;
+use Symfony\Component\Translation\TranslatableMessage;
 
 class MessageListenerTest extends TestCase
 {
@@ -114,4 +117,19 @@ public static function provideHeaders(): iterable
         ];
         yield 'Capitalized header rule (case-insensitive), replace if set' => [$initialHeaders, $defaultHeaders, $defaultHeaders, $rules];
     }
+
+    public function testTranslatableSubject()
+    {
+        if (!method_exists(TemplatedEmail::class, 'translatableSubject')) {
+            $this->markTestSkipped();
+        }
+
+        $message = new TemplatedEmail();
+        $message->translatableSubject(new TranslatableMessage('hello.world'));
+        $listener = new MessageListener(translator: new IdentityTranslator());
+        $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());
+    }
 }
diff --git a/src/Symfony/Component/Mailer/composer.json b/src/Symfony/Component/Mailer/composer.json
@@ -28,6 +28,7 @@
         "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": {
