Skip to content

Commit 4d42897

Browse files
committed
Merge branch '4.3' into 4.4
* 4.3: [Mailer] Minor tweaks in the mailer docs [Messenger] Minor tweaks for the main Messenger article [Messenger] Added a missing class import
2 parents 57acff3 + 5f0c471 commit 4d42897

File tree

3 files changed

+15
-10
lines changed

3 files changed

+15
-10
lines changed

Diff for: components/messenger.rst

+1
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,7 @@ Instead of dealing directly with the messages in the middleware you receive the
163163
Hence you can inspect the envelope content and its stamps, or add any::
164164

165165
use App\Message\Stamp\AnotherStamp;
166+
use Symfony\Component\Messenger\Envelope;
166167
use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
167168
use Symfony\Component\Messenger\Middleware\StackInterface;
168169
use Symfony\Component\Messenger\Stamp\ReceivedStamp;

Diff for: mailer.rst

+5-2
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,9 @@ and create an :class:`Symfony\\Component\\Mime\\Email` object::
122122
->text('Sending emails is fun again!')
123123
->html('<p>See Twig integration for better HTML integration!</p>');
124124

125-
$mailer->send($email);
125+
/** @var Symfony\Component\Mailer\SentMessage $sentEmail */
126+
$sentEmail = $mailer->send($email);
127+
// $messageId = $sentEmail->getMessageId();
126128

127129
// ...
128130
}
@@ -161,7 +163,8 @@ both strings or address objects::
161163

162164
Instead of calling ``->from()`` *every* time you create a new email, you can
163165
create an :doc:`event subscriber </event_dispatcher>` and listen to the
164-
``MessageEvent::class`` event to set the same ``From`` email to all messages.
166+
:class:`Symfony\\Component\\Mailer\\Event\\MessageEvent` event to set the
167+
same ``From`` email to all messages.
165168

166169
Multiple addresses are defined with the ``addXXX()`` methods::
167170

Diff for: messenger.rst

+9-8
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,10 @@ serialized::
5050

5151
.. _messenger-handler:
5252

53-
A message handler is a PHP callable, the recommended way to create it is to create a class that
54-
implements ``MessageHandlerInterface`` and has an ``__invoke()`` method that's
55-
type-hinted with the message class (or a message interface)::
53+
A message handler is a PHP callable, the recommended way to create it is to
54+
create a class that implements :class:`Symfony\\Component\\Messenger\\Handler\\MessageHandlerInterface`
55+
and has an ``__invoke()`` method that's type-hinted with the message class (or a
56+
message interface)::
5657

5758
// src/MessageHandler/SmsNotificationHandler.php
5859
namespace App\MessageHandler;
@@ -111,7 +112,7 @@ Transports: Async/Queued Messages
111112
By default, messages are handled as soon as they are dispatched. If you want
112113
to handle a message asynchronously, you can configure a transport. A transport
113114
is capable of sending messages (e.g. to a queueing system) and then
114-
:ref:`receiving them via a worker<messenger-worker>`. Messenger supports
115+
:ref:`receiving them via a worker <messenger-worker>`. Messenger supports
115116
:ref:`multiple transports <messenger-transports-config>`.
116117

117118
.. note::
@@ -503,7 +504,7 @@ different messages to them. For example:
503504
# queue_name is specific to the doctrine transport
504505
queue_name: high
505506
506-
# for amqp send to a separate exchange then queue
507+
# for AMQP send to a separate exchange then queue
507508
#exchange:
508509
# name: high
509510
#queues:
@@ -1265,7 +1266,7 @@ Envelopes & Stamps
12651266
~~~~~~~~~~~~~~~~~~
12661267

12671268
A message can be any PHP object. Sometimes, you may need to configure something
1268-
extra about the message - like the way it should be handled inside Amqp or adding
1269+
extra about the message - like the way it should be handled inside AMQP or adding
12691270
a delay before the message should be handled. You can do that by adding a "stamp"
12701271
to your message::
12711272

@@ -1319,8 +1320,8 @@ for each bus looks like this:
13191320

13201321
.. note::
13211322

1322-
These middleware names are actually shortcuts names. The real service ids
1323-
are prefixed with ``messenger.middleware.``.
1323+
These middleware names are actually shortcut names. The real service ids
1324+
are prefixed with ``messenger.middleware.`` (e.g. ``messenger.middleware.handle_message``).
13241325

13251326
The middleware are executed when the message is dispatched but *also* again when
13261327
a message is received via the worker (for messages that were sent to a transport

0 commit comments

Comments
 (0)