The Mailer Documentation #11633
The Mailer Documentation #11633
Conversation
There was a problem hiding this comment.
Very nice job! And I 😍 PHP 7+ code examples
The section talking about all twig filters (inky, etc) seems to me like it should be belong to a sub-guide (with a small reference section in the main guide that briefly mentions all integratable tools). You're often interested in just one and reading every single one seems a bit too much. Other than that major +1
| ->htmlTemplate('emails/signup.html.twig') | ||
| + ->textTemplate('emails/signup.txt.twig') | ||
| // ... | ||
| ; |
There was a problem hiding this comment.
I believe correct diff templates should indent all lines with 2 spaces, except from the ones containing + /- )
There was a problem hiding this comment.
I think what I have is correct. Looking at other parts of the docs, a diff code block (at least the way I've been creating them) involves making a normal code block (with normal indentation) and then adding + or - (plus then space) on the changed lines. That indeed makes those lines look a little "funny" - as the changed lines don't line up with the unchanged lines inside the raw rst (but it renders correctly).
| ================== ============================================= | ||
|
|
||
| Each library includes a :ref:`Flex recipe <flex-recipe>` that will add example configuration | ||
| to your ``.env`` file. For example, suppose you want to use SendGrid. First, |
There was a problem hiding this comment.
| to your ``.env`` file. For example, suppose you want to use SendGrid. First, | |
| to the ``.env`` file. For example, suppose you want to use SendGrid. First, |
| development. If you are using the SwiftmailerBundle with Symfony, you | ||
| can achieve this through configuration settings without having to make | ||
| any changes to your application's code at all. There are two main choices | ||
| when it comes to handling email during development: (a) disabling the |
There was a problem hiding this comment.
is it possible to create anchor for linked subtitle?
|
|
||
| Now, suppose you're sending an email to ``recipient@example.com`` in a controller:: | ||
|
|
||
| public function index($name, \Swift_Mailer $mailer) |
There was a problem hiding this comment.
You're right, but this is just moved from another spot in the docs - we won't update Swiftmailer docs for php7 - just not worth it (well, at least not in this PR)
|
|
||
| .. tip:: | ||
|
|
||
| Alternatively, you can open the profiler after the redirect and search |
There was a problem hiding this comment.
what about adding this directly after the previous paragraph?
not as a tip, but as a two way options
personnaly i have never used intercept_redirects
There was a problem hiding this comment.
good note, but can you propose in a separate PR? This is just moved from a different part of the docs - i don't want to update anything in email.rst for this PR
|
|
||
| When the text content of a ``TemplatedEmail`` is not explicitly defined, mailer | ||
| will generate it automatically by converting the HTML contents into text. If you | ||
| have `league/html-to-markdown`_ installed in your application, |
… many docs from mime to Mailer and writing it Co-Authored-By: Wouter J <wouterj@users.noreply.github.com> Co-Authored-By: Ricardo de Vries <ricardozegt@gmail.com> Co-Authored-By: Antoine Makdessi <antoine.makdessi@me.com>
This PR was merged into the 4.3 branch. Discussion ---------- The Mailer Documentation o/ friends! Say hello to the Mailer documentation (#11626 does the component). A lot of the docs were moved from the mime component, and pretty much everything here was tested. Reviews, questions and comments are warmly welcomed. Note: the first commit was just to "deprecate" the Swift Mailer docs and copy the `email/*` docs into the one, deprecated Swift Mailer document (`email.rst`). Mailer lives in `mailer.rst`. Cheers! Commits ------- c2e92a5 deprecating Swift Mailer and moving all docs into one spot and moving many docs from mime to Mailer and writing it
|
Thanks to everyone for the wonderful review - a lot of improvements and fixes came because of that! |
o/ friends!
Say hello to the Mailer documentation (#11626 does the component).
A lot of the docs were moved from the mime component, and pretty much everything here was tested. Reviews, questions and comments are warmly welcomed.
Note: the first commit was just to "deprecate" the Swift Mailer docs and copy the
email/*docs into the one, deprecated Swift Mailer document (email.rst). Mailer lives inmailer.rst.Cheers!