[Mailer] Add docs about Mailer stamps#17390

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

javiereguiluz merged 1 commit intosymfony:6.2fromfabpot:mailer-stamps

Oct 26, 2022

Merged

[Mailer] Add docs about Mailer stamps#17390

javiereguiluz merged 1 commit intosymfony:6.2fromfabpot:mailer-stamps

Oct 26, 2022

Conversation

Copy link

Member

fabpot commentedOct 23, 2022

Closes#17111

carsonbot added the Status: Needs Review label

Oct 23, 2022

carsonbot added this to the6.2 milestone

Oct 23, 2022

fabpot mentioned this pull request

Oct 23, 2022

[Mailer] Add a way to inject Stamps when sending an email via Messenger#17111

Closed

wouterj reviewed

Oct 23, 2022

View reviewed changes

Copy link

Member

wouterj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

Thank you Fabien!

mailer.rst

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.

Copy link

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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?

Copy link

MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

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.