Skip to content

Commit 0846490

Browse files
committed
minor #17730 [Mailer] remove QueuingMessageEvent (MrYamous)
This PR was merged into the 6.2 branch. Discussion ---------- [Mailer] remove `QueuingMessageEvent` Related to [47992 in code](symfony/symfony#47992) - QueuingMessageEvent class has been removed due to BC break Related to #17111 in doc Remove explanations about this specific event but keep new methods added in previously existing MessageEvent Commits ------- 9bc26d1 remove QueuingMessageEvent from documentation
2 parents 040bca2 + 9bc26d1 commit 0846490

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
.. tip::
14871494

14881495
When using a ``MessageEvent`` listener to
@@ -1497,48 +1504,6 @@ and their priorities:
14971504
14981505
$ php bin/console debug:event-dispatcher "Symfony\Component\Mailer\Event\MessageEvent"
14991506
1500-
QueuingMessageEvent
1501-
~~~~~~~~~~~~~~~~~~~
1502-
1503-
**Event Class**: :class:`Symfony\\Component\\Mailer\\Event\\QueuingMessageEvent`
1504-
1505-
.. versionadded:: 6.2
1506-
1507-
The ``QueuingMessageEvent`` class was introduced in Symfony 6.2.
1508-
1509-
``QueuingMessageEvent`` allows to add some logic before the email is sent to
1510-
the Messenger bus (this event is not dispatched when no bus is configured); it
1511-
extends ``MessageEvent`` to allow adding Messenger stamps to the Messenger
1512-
message sent to the bus::
1513-
1514-
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
1515-
use Symfony\Component\Mailer\Event\QueuingMessageEvent;
1516-
use Symfony\Component\Mime\Email;
1517-
1518-
public function onMessage(QueuingMessageEvent $event): void
1519-
{
1520-
$message = $event->getMessage();
1521-
if (!$message instanceof Email) {
1522-
return;
1523-
}
1524-
// do something with the message (logging, ...)
1525-
1526-
// and/or add some Messenger stamps
1527-
$event->addStamp(new SomeMessengerStamp());
1528-
}
1529-
1530-
This event lets listeners do something before a message is sent to the queue
1531-
(like adding stamps or logging) but any changes to the message or the envelope
1532-
are discarded. To change the message or the envelope, listen to
1533-
``MessageEvent`` instead.
1534-
1535-
Execute this command to find out which listeners are registered for this event
1536-
and their priorities:
1537-
1538-
.. code-block:: terminal
1539-
1540-
$ php bin/console debug:event-dispatcher "Symfony\Component\Mailer\Event\QueuingMessageEvent"
1541-
15421507
SentMessageEvent
15431508
~~~~~~~~~~~~~~~~
15441509

0 commit comments

Comments
 (0)