From 11596b0211886736c1bf14b9fc8ab1123c9c1dbd Mon Sep 17 00:00:00 2001 From: Fabien Potencier Date: Sat, 31 Dec 2022 14:16:12 +0100 Subject: [PATCH] Document MessageEvent::reject() --- mailer.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/mailer.rst b/mailer.rst index 7c8ab512493..759fed60570 100644 --- a/mailer.rst +++ b/mailer.rst @@ -1483,6 +1483,20 @@ the email is sent:: // do something with the message } +If you want to stop the Message from being sent, call ``reject()`` (it will +also stop the event propagation):: + + use Symfony\Component\Mailer\Event\MessageEvent; + + public function onMessage(MessageEvent $event): void + { + $event->reject(); + } + +.. versionadded:: 6.3 + + The ``reject()`` method was introduced in Symfony 6.3. + .. tip:: When using a ``MessageEvent`` listener to