Removed Mailer component docs #13945

wouterj · 2020-07-08T20:18:37Z

The component is quite easy to use in a standalone project. The example in the component's README will be enough I think (no need to confuse framework users by adding the examples in this doc).

Meanwhile, I'm not sure what to do with the Mime component. Should we move it into a subguide (/mailer/mime.rst)? It doesn't really make sense to have it as a main guide I think.

mailer.rst

wouterj · 2020-07-09T16:18:31Z

Oh, I'm sorry for the countless copy-paste mistakes. Thanks for your detailed review!

This PR was merged into the 4.4 branch. Discussion ---------- [Mailer] Updated README for the Mailer component | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | n/a | License | MIT | Doc PR | symfony/symfony-docs#13945 I think it's worth adding a second example showcasing the twig integration for 2 reasons: * If you're used to use this component in the framework, I think it's likely you want Twig integration in standalone apps. * The integration actually lives in `symfony/twig-bridge`, it won't be very easy to catch while reading the component code - unless you're very comfortable with the Symfony architecture. Commits ------- 696560c Updated README for the Mailer component

This PR was merged into the 4.4 branch. Discussion ---------- [Mailer] Updated README for the Mailer component | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | n/a | License | MIT | Doc PR | symfony/symfony-docs#13945 I think it's worth adding a second example showcasing the twig integration for 2 reasons: * If you're used to use this component in the framework, I think it's likely you want Twig integration in standalone apps. * The integration actually lives in `symfony/twig-bridge`, it won't be very easy to catch while reading the component code - unless you're very comfortable with the Symfony architecture. Commits ------- 696560c690 Updated README for the Mailer component

fabpot · 2020-07-31T06:55:28Z

The change upstream has been merged now.

xabbuh · 2020-08-03T08:04:54Z

Thank you Wouter.

oxan · 2020-09-11T16:03:05Z

This change completely removed this paragraph from the documentation.

wouterj · 2020-09-11T19:27:12Z

Hi @oxan! The null DSN is documented here: https://symfony.com/doc/current/mailer.html#disabling-delivery

oxan · 2020-09-12T09:27:59Z

@wouterj Sorry, I was too curt with my comment. What I meant was that the sendmail DSN isn't documented anymore.

wouterj · 2020-09-12T10:19:05Z

No problem @oxan, thanks for clarifying :) I think I removed it in favor of this section https://symfony.com/doc/current/mailer.html#transport-setup . That section doesn't explicitly say "sendmail", but what it shows (native SMTP) is in fact sendmail. If you think we should be more explicit about it, please consider hitting the "edit this page" button at the top right. (btw, from my understanding, smtp:// and smtp+sendmail:// are equal)

oxan · 2020-09-12T20:56:22Z

@wouterj As I understand the code (I haven't actually verified this), smtp:// will connect to an SMTP server on localhost, while smtp+sendmail:// will invoke sendmail and talk SMTP over stdin to it (so it isn't necessary to have an SMTP server running). It's also possible to invoke sendmail without talking SMTP to it, but counterintuitively that is not achieved by using sendmail:// (which is indeed equal to smtp+sendmail://), but you need to explicitly specify the command as an option using sendmail://?command=/usr/sbin/sendmail -oi -t (which is also not documented). Furthermore, the note in the documentation that user, pass and port are optional implies that host isn't and you are required to specify a host.

I think it'd be ideal to have a subsection for every transport along with the required parameters and the available options, but that'd be a quite involved change.

This PR was merged into the 4.4 branch. Discussion ---------- [Mailer] Updated README for the Mailer component | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Tickets | n/a | License | MIT | Doc PR | symfony/symfony-docs#13945 I think it's worth adding a second example showcasing the twig integration for 2 reasons: * If you're used to use this component in the framework, I think it's likely you want Twig integration in standalone apps. * The integration actually lives in `symfony/twig-bridge`, it won't be very easy to catch while reading the component code - unless you're very comfortable with the Symfony architecture. Commits ------- 696560c690 Updated README for the Mailer component

carsonbot added the Status: Needs Review label Jul 8, 2020

wouterj force-pushed the components/move-new-in-4.4 branch from 2858190 to 868c0bd Compare July 8, 2020 20:21

wouterj commented Jul 8, 2020

View reviewed changes