Skip to content

[Mailer] Fix body renderer check #48366

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
Nov 28, 2022
Merged

[Mailer] Fix body renderer check #48366

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
6 changes: 0 additions & 6 deletions 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,11 +11,9 @@

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;
use Symfony\Component\Mailer\Exception\LogicException;
use Symfony\Component\Mailer\Exception\RuntimeException;
use Symfony\Component\Mime\BodyRendererInterface;
use Symfony\Component\Mime\Header\Headers;
Expand Down Expand Up @@ -121,10 +119,6 @@ private function setHeaders(Message $message): void
private function renderMessage(Message $message): void
{
if (!$this->renderer) {
if ($message instanceof TemplatedEmail && ($message->getTextTemplate() || $message->getHtmlTemplate())) {
throw new LogicException(sprintf('You must configure a "%s" when a "%s" instance has a text or HTML template set.', BodyRendererInterface::class, get_debug_type($message)));
}

return;
}

Expand Down
23 changes: 23 additions & 0 deletions src/Symfony/Component/Mailer/Tests/Transport/AbstractTransportTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,17 @@
namespace Symfony\Component\Mailer\Tests\Transport;

use PHPUnit\Framework\TestCase;
use Symfony\Bridge\Twig\Mime\BodyRenderer;
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mailer\EventListener\MessageListener;
use Symfony\Component\Mailer\Exception\LogicException;
use Symfony\Component\Mailer\Transport\NullTransport;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\RawMessage;
use Twig\Environment;
use Twig\Loader\ArrayLoader;

/**
* @group time-sensitive
Expand Down Expand Up @@ -55,4 +61,21 @@ public function testSendingRawMessages()
$transport = new NullTransport();
$transport->send(new RawMessage('Some raw email message'));
}

public function testNotRenderedTemplatedEmail()
{
$this->expectException(LogicException::class);

$transport = new NullTransport(new EventDispatcher());
$transport->send((new TemplatedEmail())->htmlTemplate('Some template'));
}

public function testRenderedTemplatedEmail()
{
$transport = new NullTransport($dispatcher = new EventDispatcher());
$dispatcher->addSubscriber(new MessageListener(null, new BodyRenderer(new Environment(new ArrayLoader(['tpl' => 'Some message'])))));

$sentMessage = $transport->send((new TemplatedEmail())->to('me@example.com')->from('me@example.com')->htmlTemplate('tpl'));
$this->assertMatchesRegularExpression('/Some message/', $sentMessage->getMessage()->toString());
}
}
7 changes: 7 additions & 0 deletions src/Symfony/Component/Mailer/Transport/AbstractTransport.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,15 @@
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Log\LoggerInterface;
use Psr\Log\NullLogger;
use Symfony\Bridge\Twig\Mime\TemplatedEmail;
use Symfony\Component\Mailer\Envelope;
use Symfony\Component\Mailer\Event\FailedMessageEvent;
use Symfony\Component\Mailer\Event\MessageEvent;
use Symfony\Component\Mailer\Event\SentMessageEvent;
use Symfony\Component\Mailer\Exception\LogicException;
use Symfony\Component\Mailer\SentMessage;
use Symfony\Component\Mime\Address;
use Symfony\Component\Mime\BodyRendererInterface;
use Symfony\Component\Mime\RawMessage;

/**
Expand Down Expand Up @@ -73,6 +76,10 @@ public function send(RawMessage $message, Envelope $envelope = null): ?SentMessa
$envelope = $event->getEnvelope();
$message = $event->getMessage();

if ($message instanceof TemplatedEmail && ($message->getTextTemplate() || $message->getHtmlTemplate())) {
throw new LogicException(sprintf('You must configure a "%s" when a "%s" instance has a text or HTML template set.', BodyRendererInterface::class, get_debug_type($message)));
}

$sentMessage = new SentMessage($message, $envelope);

try {
Expand Down
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 @@ -27,7 +27,8 @@
"require-dev": {
"symfony/console": "^5.4|^6.0",
"symfony/http-client-contracts": "^1.1|^2|^3",
"symfony/messenger": "^6.2"
"symfony/messenger": "^6.2",
"symfony/twig-bridge": "^6.2"
},
"conflict": {
"symfony/http-kernel": "<5.4",
Expand Down