Skip to content

[Mailer] Document MessageEvent::reject() #17635

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
Jan 2, 2023
+14 −0
Merged

[Mailer] Document MessageEvent::reject() #17635

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
14 changes: 14 additions & 0 deletions mailer.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down