Add Mailer send and debug commands #43687

fritzmg · 2021-10-24T20:45:36Z

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

The old and deprecated Swiftmailer Bundle had a few useful features that are still absent with the current Symfony Mailer implementation: for instance being able to quickly test your email configuration by sending a test email via the command line.

This PR provides a mailer:send and mailer:debug command. The implementation is more or less copied over from the Swiftmailer Bundle.

mailer:send interactively asks you for the sender address, recipient address, subject and message body and then sends the email via the default mailer transport. Additionally you can set the chosen transport via --transport for example, if you use multiple mailer transports.

mailer:debug shows you name and DSN of all your configured mailer transports (or just name and DSN of a specified transport).

Discussion

Currently there is no way to retrieve the available mailer transports from the container. By contrast the Swiftmailer Bundle registers each individual transport in the container as a service, which can then be retrieved in the commands. In the current Mailer implementation they are only passed to mailer.transports and cannot be retrieved otherwise (or at least I could not figure out how). This PR implements a getTransports method for the Transports class, however I suppose it should be done differently (new interface?).

src/Symfony/Component/Mailer/CHANGELOG.md

src/Symfony/Component/Mailer/Command/DebugCommand.php

src/Symfony/Component/Mailer/Command/SendCommand.php

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

fritzmg · 2021-10-25T17:28:10Z

for the send, maybe #39173 and #37409 are still relevant

Oh I see, didn't find the existing issues/PRs before.

NewEmailCommand: I don't see the use cases and as such, I don't want it in core

@fabpot I agree with the comments in previous PRs, i.e. that it is a helpful tool to test sending of emails in your application - and we have used it as such in numerous projects with Swiftmailer Bundle. Since we switched from Swiftmailer to Symfony Mailer in Contao 4.10 and up however, this feature is sorely missed by us and other members of the Contao community. If the decision is (again) made to not include this, we can of course instead provide a command within Contao.

vinceAmstoutz · 2022-05-23T07:55:04Z

@fabpot Why 6.2 and not 6.1 ? Thanks you for advance.

FabienPapet · 2022-05-23T08:10:08Z

@vinceAmstoutz 6.1 is in feature freeze, so only bug fixes will be fixed until 6.1 is out (end of this month)

fritzmg · 2022-05-23T08:15:01Z

@FabienPapet I think the question is why this has been moved from 5.4 to 6.1 and then from 6.1 to 6.2, i.e. is there still any intention of merging this? There was no feedback to my last comment and thus I haven't followed up here and did not fix the conflict yet.

vinceAmstoutz · 2022-05-23T08:59:30Z

@FabienPapet I think the question is why this has been moved from 5.4 to 6.1 and then from 6.1 to 6.2, i.e. is there still any intention of merging this? There was no feedback to my last comment and thus I haven't followed up here and did not fix the conflict yet.

Exactly, thx !

vinceAmstoutz · 2022-05-23T09:00:28Z

@vinceAmstoutz 6.1 is in feature freeze, so only bug fixes will be fixed until 6.1 is out (end of this month)

See @fritzmg response. Thx for advance

FabienPapet · 2022-05-23T09:06:11Z

I think this is a miss for this PR to not be reviewed, but I guess as this PR has not been updated, It has been forgotten, and now moved to 6.2.

I'd also really liked to see this feature in 6.1 as i always create a mail:send command in all my projects but I saw this PR only today :/

fritzmg · 2022-05-23T09:08:33Z

This feature has been rejected for almost two years now - I did not want to put in any additional effort before confirming that it will now finally make it in.

FabienPapet · 2022-05-23T09:13:29Z

I understand that, I think we need to (re)consider that again after 2 years ? Maybe open a RFC for this ?

fritzmg · 2022-06-20T17:43:00Z

Maybe open a RFC for this ?

Open where? I just need a confirmation from @fabpot (or whoever) here that Symfony is interested in merging this and then I can continue working on this PR.

fritzmg · 2022-06-20T18:20:21Z

In any case you can now install inspiredminds/symfony-mailer-command-bundle for the basic mailer:send command.

vinceAmstoutz · 2022-06-21T06:37:39Z

It's still sad to come to this! I regret (although I love the Framework ;) ) the management of this @fabpot @FabienPapet ticket. It's not nice to leave people in the dark and in doubt for so long ...

Sincerely.

FabienPapet · 2022-06-21T13:55:12Z

ping @nicolas-grekas @chalasr , It looks like no one from the core team has been giving it's opinion on this. Any help ? :)

src/Symfony/Component/Mailer/Command/DebugCommand.php

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php

fabpot · 2022-06-22T07:30:41Z

src/Symfony/Component/Mailer/Command/SendCommand.php

+            ->addOption('transport', null, InputOption::VALUE_OPTIONAL, 'The transport to be used')
+            ->addOption('content-type', null, InputOption::VALUE_REQUIRED, 'The body content type of the message', 'text/plain')
+            ->addOption('charset', null, InputOption::VALUE_REQUIRED, 'The body charset of the message', 'utf-8')
+            ->addOption('body-source', null, InputOption::VALUE_REQUIRED, 'The source of the body [stdin|file]', 'stdin')


I would only support stdin as it also allows to get content from a file.

src/Symfony/Component/Mailer/Command/SendCommand.php

src/Symfony/Component/Mailer/Transport/Transports.php

fritzmg · 2022-06-23T07:26:33Z

General question: I originally put the command(s) in Symfony\Component\Mailer\Command, however now I realise they should probably live in Symfony\Bundle\FrameworkBundle\Command, correct?

src/Symfony/Bundle/FrameworkBundle/Command/MailerSendCommand.php

fabpot · 2022-07-23T14:47:49Z

Closing in favor of #47040 which implements a command that eases testing sending an email instead of trying to have a semi-generic command to send emails. It should be enough to cover the use cases mentioned here, and as a bonus, it bypasses the message bus to ease testing.

This PR was merged into the 6.2 branch. Discussion ---------- Add a mailer:test command | Q | A | ------------- | --- | Branch? | 6.2 | Bug fix? | no | New feature? | yes  | Deprecations? | no  | Tickets | Fix #43687, Fix #39173, Fix #37409 | License | MIT | Doc PR | This PR introduces a `mailer:test` command that helps test if sending emails works correctly. The only argument is the `To` header. Everything is optional. There is no support for complex emails (STDIN for body, HTML support, attachments, ...) as the goal is to test if a transport works correctly. Note that this command bypasses the Messenger bus if configured to ease testing even when the messenger consumer is not running. Commits ------- dee0d09 Add a mailer:test command

carsonbot added Status: Needs Review Feature labels Oct 24, 2021

carsonbot added this to the 5.4 milestone Oct 24, 2021

fritzmg changed the title ~~Add Mailer send and debug commands~~ [Mailer] Add Mailer send and debug commands Oct 24, 2021

OskarStark reviewed Oct 25, 2021

View reviewed changes

src/Symfony/Component/Mailer/CHANGELOG.md Outdated Show resolved Hide resolved

OskarStark reviewed Oct 25, 2021

View reviewed changes

src/Symfony/Component/Mailer/Command/DebugCommand.php Outdated Show resolved Hide resolved

src/Symfony/Component/Mailer/Command/SendCommand.php Outdated Show resolved Hide resolved

noniagriconomie reviewed Oct 25, 2021

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/FrameworkExtension.php Show resolved Hide resolved

fabpot modified the milestones: 5.4, 6.1 Oct 29, 2021

fritzmg requested review from chalasr, dunglas, jderusse, lyrixx, wouterj, xabbuh and yceruto as code owners December 26, 2021 18:38

fritzmg force-pushed the mailer-command branch 2 times, most recently from 31adda6 to 9982509 Compare December 26, 2021 18:44

fritzmg mentioned this pull request Dec 26, 2021

Add contao:mailer:send command contao/contao#3869

Closed

fabpot modified the milestones: 6.1, 6.2 May 20, 2022

wouterj removed their request for review May 23, 2022 10:34

fabpot requested changes Jun 22, 2022

View reviewed changes

carsonbot added Status: Needs Work and removed Status: Needs Review labels Jun 22, 2022

carsonbot changed the title ~~[Mailer] Add Mailer send and debug commands~~ Add Mailer send and debug commands Jun 22, 2022

fritzmg force-pushed the mailer-command branch from 19ded84 to 579a28b Compare June 23, 2022 07:37

fritzmg requested a review from fabpot June 23, 2022 07:38

carsonbot added Status: Needs Review and removed Status: Needs Work labels Jun 23, 2022

fritzmg force-pushed the mailer-command branch from 579a28b to 81f104f Compare June 23, 2022 07:41

fabpot requested changes Jun 23, 2022

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Command/MailerSendCommand.php Show resolved Hide resolved

src/Symfony/Bundle/FrameworkBundle/Command/MailerSendCommand.php Show resolved Hide resolved

carsonbot added Status: Needs Work and removed Status: Needs Review labels Jun 23, 2022

94noni reviewed Jul 13, 2022

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Command/MailerSendCommand.php Show resolved Hide resolved

[Mailer] Add mailer send and debug commands

2931282

fabpot force-pushed the mailer-command branch 5 times, most recently from 7a0a90a to 2931282 Compare July 23, 2022 14:22

fabpot mentioned this pull request Jul 23, 2022

Add a mailer:test command #47040

Merged

fabpot closed this Jul 23, 2022

fritzmg deleted the mailer-command branch August 30, 2023 10:59

Uh oh!

Add Mailer send and debug commands #43687

Add Mailer send and debug commands #43687

Uh oh!

Conversation

fritzmg commented Oct 24, 2021

Discussion

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fritzmg commented Oct 25, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vinceAmstoutz commented May 23, 2022

Uh oh!

FabienPapet commented May 23, 2022

Uh oh!

fritzmg commented May 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vinceAmstoutz commented May 23, 2022

Uh oh!

vinceAmstoutz commented May 23, 2022

Uh oh!

FabienPapet commented May 23, 2022

Uh oh!

fritzmg commented May 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

FabienPapet commented May 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fritzmg commented Jun 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

fritzmg commented Jun 20, 2022

Uh oh!

vinceAmstoutz commented Jun 21, 2022

Uh oh!

FabienPapet commented Jun 21, 2022

Uh oh!

Uh oh!

Uh oh!

fabpot Jun 22, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fritzmg commented Jun 23, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fabpot commented Jul 23, 2022

Uh oh!

Uh oh!

fritzmg commented Oct 25, 2021 •

edited

Loading

fritzmg commented May 23, 2022 •

edited

Loading

fritzmg commented May 23, 2022 •

edited

Loading

FabienPapet commented May 23, 2022 •

edited

Loading

fritzmg commented Jun 20, 2022 •

edited

Loading