Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

[Mailer] fix: use message object from event #47822

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 15, 2022

Conversation

rogamoore
Copy link
Contributor

Q A
Branch? 4.4
Bug fix? yes
New feature? no
Deprecations? no
Tickets -
License MIT
Doc PR -

Based on the documentation https://symfony.com/doc/current/mailer.html#messageevent

MessageEvent allows to change the Message and the Envelope before the email is sent

However right now you can do only the following:

  • modify the Envelope object or replace it with a new one
  • modify the Message object (e.g. change subject, update recipients)

But you can not replace the Message object, even if there is a method setMessage on the event.
The reason is that the AbstractTransport does get the updated/replaced Envelope object from the event, but not the Message object:

        if (null !== $this->dispatcher) {
            $event = new MessageEvent($message, $envelope, (string) $this);
            $this->dispatcher->dispatch($event);
            $envelope = $event->getEnvelope();
            // here we should also get the message
        }

So why would we need to replace the Message object in the first place?
One example would be the signing of messages (see example here https://symfony.com/doc/current/mailer.html#dkim-signer) in a listener. The signer does not modify the existing Message object, but returns a new instance. If we then use $event->setMessage($signedEmail) it simply doesn't work, because it's going to be ignored in the transport.

See also this comment here, where someone encountered the same issue: #39354 (comment)

@carsonbot
Copy link

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 6.2 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@nicolas-grekas nicolas-grekas requested a review from fabpot October 11, 2022 15:13
Copy link
Member

@xabbuh xabbuh left a comment

Choose a reason for hiding this comment

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

LGTM

@fabpot
Copy link
Member

fabpot commented Oct 15, 2022

Thank you @rogamoore.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants
Morty Proxy This is a proxified and sanitized view of the page, visit original site.