[Mailer] [DX] Introduce send email command #39173

gmorel · 2020-11-25T15:58:16Z

Q	A
Branch?	5.x for features
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets	-
License	MIT
Doc PR	symfony/symfony-docs#...

Pain Point

Sometimes in production you might have a doubt whether your mailer is well configured or if your mail supplier is still up and running.

Aim is to allow to quickly check if your mailer configuration or supplier is operational in (production or elsewhere).

This is the same (lighter) feature we had in SwiftMailerBundle.

Usage

console debug:mailer:email:send [email protected] [email protected] --subject=Test --body=body
console debug:mailer:email:send

TODO

Implement console debug:mailer:email:send [email protected] [email protected] --subject=Test --body=body
- With Unit Test
Implement interactive console debug:mailer:email:send
- With Unit Test
Make sure no issue if the symfony/mailer is not installed
Passing an optional file
Update CHANGELOG.md
Update Documentation
- [Mailer] Add feature mailer:send-email symfony-docs#14725

Keep up the good work 🚀

carsonbot · 2020-11-25T15:58:17Z

Hey!

I like what you have done here. Keep up the good work.

To help keep things organized, we don't allow "Draft" pull requests. Could you please click the "ready for review" button or close this PR and open a new one when you are done?

Note that a pull request does not have to be "perfect" or "ready for merge" when you first open it. We just want it to be ready for a first review.

Cheers!

Carsonbot

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

carsonbot · 2020-11-25T16:03:31Z

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 5.x 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

src/Symfony/Bundle/FrameworkBundle/Resources/config/console.php

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

src/Symfony/Component/Mailer/CHANGELOG.md

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

OskarStark · 2020-12-05T12:07:02Z

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

+    }
+
+    /**
+     * {@inheritdoc}


@stof do we really need all the inheritdoc?

Its up to you. I can remove them.

But my 2cents:
Indeed if you look at the code in an IDE you will have the fancy icon

However when you review a code in github having this comment ease the understanding. And especially it highlights the constraints linked to this inheritance.

gmorel · 2020-12-20T14:13:11Z

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

+    /**
+     * {@inheritdoc}
+     */
+    public function __construct(?MailerInterface $mailer)


todo: check if I can remove the nullable without breaking everything

OskarStark · 2020-12-20T14:26:37Z

Can you please rename your PR title:

- [Mailer] introduce debug command - DX
+ [Mailer] [DX] Introduce debug command

Thanks

gmorel · 2020-12-20T14:36:52Z

php composer.phar remove symfony/mailer

php link /home/gmorel/dev/opensource/symfony_full_5.2
in order to simulate php composer.phar require symfony/mailer

gmorel · 2020-12-21T10:36:23Z

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

+     */
+    protected function execute(InputInterface $input, OutputInterface $output): int
+    {
+        switch ($input->getOption('body-source')) {


Stolen from https://github.com/symfony/swiftmailer-bundle/blob/main/Command/NewEmailCommand.php#L79-L92

Linked to symfony/symfony#39173

OskarStark · 2020-12-21T11:36:23Z

src/Symfony/Component/Mailer/CHANGELOG.md

@@ -5,6 +5,8 @@ CHANGELOG
 -----

 * added the `mailer` monolog channel and set it on all transport definitions
+ * added `console mailer:send-email` command to check if your mailer configuration or supplier is (still) operational


Suggested change

* added `console mailer:send-email` command to check if your mailer configuration or supplier is (still) operational

* added `mailer:send-email` command to check if your mailer configuration or supplier is (still) operational

OskarStark · 2020-12-21T11:37:06Z

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

+- <info>php %command.full_name% [email protected] [email protected]</info>
+- <info>php %command.full_name% [email protected] [email protected] --subject=Test --body=body</info>
+
+You can get body of message from a file:


Suggested change

You can get body of message from a file:

Use a file for the body:

Aim is to allow to test if your mailer configuration or supplier is operational in production Usage - console mailer:send-email [email protected] [email protected] - console mailer:send-email [email protected] [email protected] --subject=Test --body=body - console mailer:send-email [email protected] [email protected] --subject=Test --body-source=file --body=/path/to/file

chalasr · 2020-12-21T11:49:14Z

Be careful here, this has been proposed several times and rejected: #37409. Better wait for @fabpot' thoughts before moving forward.

gmorel · 2020-12-21T11:52:24Z

Thanks @chalasr, I didn't see it.

gmorel · 2020-12-21T12:02:00Z

I close the PR in order to avoid unnecessary pressure to @fabpot.
Feel free to re-open it if you change your mind.

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

gmorel force-pushed the feature/5.x_mailer_debug_command branch from e34cca3 to 6676087 Compare November 25, 2020 16:01

gmorel commented Nov 25, 2020

View reviewed changes

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

gmorel marked this pull request as ready for review November 25, 2020 16:03

carsonbot added Status: Needs Review Mailer Feature labels Nov 25, 2020

gmorel force-pushed the feature/5.x_mailer_debug_command branch from 6676087 to fa19a00 Compare November 25, 2020 16:15

gmorel commented Nov 25, 2020

View reviewed changes

src/Symfony/Bundle/FrameworkBundle/Resources/config/console.php Outdated Show resolved Hide resolved

gmorel force-pushed the feature/5.x_mailer_debug_command branch 5 times, most recently from 0718900 to be4adbc Compare November 25, 2020 16:37

stof requested changes Nov 25, 2020

View reviewed changes

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

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

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

carsonbot added Status: Needs Work and removed Status: Needs Review labels Nov 25, 2020

stof reviewed Nov 25, 2020

View reviewed changes

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

gmorel force-pushed the feature/5.x_mailer_debug_command branch 3 times, most recently from d3d3f5d to e5a6c8e Compare November 25, 2020 18:03

gmorel commented Nov 25, 2020

View reviewed changes

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

gmorel force-pushed the feature/5.x_mailer_debug_command branch from e5a6c8e to d64c4da Compare November 26, 2020 08:56

jderusse reviewed Nov 27, 2020

View reviewed changes

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

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

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

jderusse added this to the 5.x milestone Dec 4, 2020

OskarStark reviewed Dec 5, 2020

View reviewed changes

gmorel force-pushed the feature/5.x_mailer_debug_command branch 2 times, most recently from 660c670 to 4a139f6 Compare December 9, 2020 15:02

gmorel force-pushed the feature/5.x_mailer_debug_command branch from 4a139f6 to fe1a6b2 Compare December 20, 2020 14:11

gmorel commented Dec 20, 2020

View reviewed changes

gmorel force-pushed the feature/5.x_mailer_debug_command branch from fe1a6b2 to 2cc5306 Compare December 20, 2020 14:34

gmorel changed the title ~~[Mailer] introduce debug command - DX~~ [Mailer] [DX] Introduce debug command Dec 20, 2020

gmorel force-pushed the feature/5.x_mailer_debug_command branch 4 times, most recently from 5e6b394 to 00f7a2b Compare December 21, 2020 10:35

gmorel commented Dec 21, 2020

View reviewed changes

gmorel force-pushed the feature/5.x_mailer_debug_command branch 2 times, most recently from 6d29758 to a899719 Compare December 21, 2020 10:46

gmorel changed the title ~~[Mailer] [DX] Introduce debug command~~ [Mailer] [DX] Introduce send email command Dec 21, 2020

gmorel force-pushed the feature/5.x_mailer_debug_command branch 2 times, most recently from 8482ac1 to 796349b Compare December 21, 2020 11:00

gmorel added a commit to gmorel/symfony-docs that referenced this pull request Dec 21, 2020

[Mailer] Add feature mailer:send-email

05c6968

Linked to symfony/symfony#39173

gmorel mentioned this pull request Dec 21, 2020

[Mailer] Add feature mailer:send-email symfony/symfony-docs#14725

Closed

OskarStark reviewed Dec 21, 2020

View reviewed changes

gmorel force-pushed the feature/5.x_mailer_debug_command branch from 796349b to 7d3f884 Compare December 21, 2020 11:49

gmorel closed this Dec 21, 2020

noniagriconomie mentioned this pull request Oct 25, 2021

Add Mailer send and debug commands #43687

Closed

fabpot mentioned this pull request Jul 23, 2022

Add a mailer:test command #47040

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Mailer] [DX] Introduce send email command #39173

[Mailer] [DX] Introduce send email command #39173

gmorel commented Nov 25, 2020 •

edited

Loading

carsonbot commented Nov 25, 2020

carsonbot commented Nov 25, 2020

OskarStark Dec 5, 2020

gmorel Dec 20, 2020

gmorel Dec 20, 2020

OskarStark commented Dec 20, 2020

gmorel commented Dec 20, 2020

gmorel Dec 21, 2020

OskarStark Dec 21, 2020

OskarStark Dec 21, 2020

chalasr commented Dec 21, 2020

gmorel commented Dec 21, 2020

gmorel commented Dec 21, 2020

	* added `console mailer:send-email` command to check if your mailer configuration or supplier is (still) operational
	* added `mailer:send-email` command to check if your mailer configuration or supplier is (still) operational

	You can get body of message from a file:
	Use a file for the body:

[Mailer] [DX] Introduce send email command #39173

[Mailer] [DX] Introduce send email command #39173

Conversation

gmorel commented Nov 25, 2020 • edited Loading

Pain Point

TODO

carsonbot commented Nov 25, 2020

carsonbot commented Nov 25, 2020

OskarStark Dec 5, 2020

Choose a reason for hiding this comment

gmorel Dec 20, 2020

Choose a reason for hiding this comment

gmorel Dec 20, 2020

Choose a reason for hiding this comment

OskarStark commented Dec 20, 2020

gmorel commented Dec 20, 2020

gmorel Dec 21, 2020

Choose a reason for hiding this comment

OskarStark Dec 21, 2020

Choose a reason for hiding this comment

OskarStark Dec 21, 2020

Choose a reason for hiding this comment

chalasr commented Dec 21, 2020

gmorel commented Dec 21, 2020

gmorel commented Dec 21, 2020

gmorel commented Nov 25, 2020 •

edited

Loading