[Mailer] Return SentMessage from Mailer::send if available
#38517
Conversation
| @@ -26,5 +26,5 @@ interface MailerInterface | |||
| /** | |||
| * @throws TransportExceptionInterface | |||
| */ | |||
| public function send(RawMessage $message, Envelope $envelope = null): void; | |||
| public function send(RawMessage $message, Envelope $envelope = null): ?SentMessage; | |||
There was a problem hiding this comment.
This is a BC break and must be reverted. :/
|
I was afraid that this is a BC break. Could we target that for Symfony 6? :) Could I add an additional method to
That's a possible solution, but then I have to build more code around it than I'd like. I think returning the |
Im sorry, no. See https://symfony.com/doc/current/contributing/code/bc.html
I dont understand what you mean with "more code around it". I assume that you have a class like this (that uses your patch): class WelcomeEmailSender
{
private MailerInterface $mailer;
private function sendWelcome() {
$message = new RawMessage(/**/);
$sentMessage = $this->mailer->send($message);
// Or store it in a log file.
echo $sentMessage->getMessageId();
}
}Isn't just to do this and you are all done: - private MailerInterface $mailer;
+ private TransportInterface $mailer; |
|
Oh, you're right, I see! I didn't realize that I can also get the TransportInterface through DI. That works fine for my use-case. Thanks a lot @Nyholm, sorry for abusing this PR for support. |
Since #36424, you can get the
SentMessageif sending was handled by the messenger. But there's no easy and developer friendly way to do it without messenger.This has been discussed a few times already (threads in #35670, #33681, #35670), but none of these discussions have resulted in a solution with good DX.
The
SentMessagehelps you get the Messge-ID, which some transports (such as Amazon SES) set by themselves. That might be useful as proof-of-delivery or when building something like a ticketing system (for matching replies usingIn-Reply-ToandReferencesheaders).I think returning
SentMessagehere is dev-friendly and pragmatic: If we have it, we return it. If we don't have it, we returnnull.