[Mailer] Add docs about Mailer stamps #17390
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wouterj
reviewed
Oct 23, 2022
Comment on lines
+1488
to
+1495
| This event lets listeners do something before a message is sent to the queue | ||
| (like adding stamps or logging) but any changes to the message or the envelope | ||
| are discarded. To change the message or the envelope, listen to | ||
| ``MessageEvent`` instead. |
There was a problem hiding this comment.
This paragraph seems to contradict the "do something with the message" comment in the code example above.
Is it saying "you can change the messenger message, but not the email" or is this a copy-paste error?
There was a problem hiding this comment.
You can change the message if you want to, it will just be ignored. That's useful when you want to get errors early on (before sending things to the queue) like rendering the message to be sure there are no errors in templates. I have added a parenthesis with logging t make things a bit clearer about the primary use cases.
carsonbot
changed the title
|
Nice contribution! Thanks Fabien. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #17111