Skip to content

Commit d7ba5b8

Browse files
committed
Merge branch '6.2' into 6.3
* 6.2: remove QueuingMessageEvent from documentation
2 parents efc6a79 + 0846490 commit d7ba5b8

File tree

1 file changed

+8
-43
lines changed

1 file changed

+8
-43
lines changed

mailer.rst

Lines changed: 8 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1480,9 +1480,16 @@ the email is sent::
14801480
if (!$message instanceof Email) {
14811481
return;
14821482
}
1483-
// do something with the message
1483+
// do something with the message (logging, ...)
1484+
1485+
// and/or add some Messenger stamps
1486+
$event->addStamp(new SomeMessengerStamp());
14841487
}
14851488

1489+
.. versionadded:: 6.2
1490+
1491+
Methods ``addStamp()`` and ``getStamps()`` were introduced in Symfony 6.2.
1492+
14861493
If you want to stop the Message from being sent, call ``reject()`` (it will
14871494
also stop the event propagation)::
14881495

@@ -1511,48 +1518,6 @@ and their priorities:
15111518
15121519
$ php bin/console debug:event-dispatcher "Symfony\Component\Mailer\Event\MessageEvent"
15131520
1514-
QueuingMessageEvent
1515-
~~~~~~~~~~~~~~~~~~~
1516-
1517-
**Event Class**: :class:`Symfony\\Component\\Mailer\\Event\\QueuingMessageEvent`
1518-
1519-
.. versionadded:: 6.2
1520-
1521-
The ``QueuingMessageEvent`` class was introduced in Symfony 6.2.
1522-
1523-
``QueuingMessageEvent`` allows to add some logic before the email is sent to
1524-
the Messenger bus (this event is not dispatched when no bus is configured); it
1525-
extends ``MessageEvent`` to allow adding Messenger stamps to the Messenger
1526-
message sent to the bus::
1527-
1528-
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
1529-
use Symfony\Component\Mailer\Event\QueuingMessageEvent;
1530-
use Symfony\Component\Mime\Email;
1531-
1532-
public function onMessage(QueuingMessageEvent $event): void
1533-
{
1534-
$message = $event->getMessage();
1535-
if (!$message instanceof Email) {
1536-
return;
1537-
}
1538-
// do something with the message (logging, ...)
1539-
1540-
// and/or add some Messenger stamps
1541-
$event->addStamp(new SomeMessengerStamp());
1542-
}
1543-
1544-
This event lets listeners do something before a message is sent to the queue
1545-
(like adding stamps or logging) but any changes to the message or the envelope
1546-
are discarded. To change the message or the envelope, listen to
1547-
``MessageEvent`` instead.
1548-
1549-
Execute this command to find out which listeners are registered for this event
1550-
and their priorities:
1551-
1552-
.. code-block:: terminal
1553-
1554-
$ php bin/console debug:event-dispatcher "Symfony\Component\Mailer\Event\QueuingMessageEvent"
1555-
15561521
SentMessageEvent
15571522
~~~~~~~~~~~~~~~~
15581523

0 commit comments

Comments
 (0)