Skip to content

Updated the main email article to Symfony 4/Flex #8652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 17, 2017

Conversation

javiereguiluz
Copy link
Member

No description provided.

email.rst Outdated
the power of the `Swift Mailer`_ library. This bundle comes with the Symfony
Standard Edition.
Sending emails is a common task for any web application and one that has
special complications and potential pitfalls. Symfony provides a mailer feature
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the first sentence is crap... and it's not your change - I think the old sentence (I probably wrote it?) is crap. Let's remove it entirely.

email.rst Outdated

.. code-block:: xml
If your application doesn't use Symfony Flex, follow the installation
instructions of the `SwiftMailerBundle`_.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

instructions on SwiftMailerBundle...

email.rst Outdated
These values (e.g. ``%mailer_transport%``), are reading from the parameters
that are set in the :ref:`parameters.yml <config-parameters.yml>` file. You
can modify the values in that file, or set the values directly here.
The ``config/packages/swiftmailer.yaml`` file created when installing the mailer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... file that's created...

email.rst Outdated
that are set in the :ref:`parameters.yml <config-parameters.yml>` file. You
can modify the values in that file, or set the values directly here.
The ``config/packages/swiftmailer.yaml`` file created when installing the mailer
provides all the initial config needed to make it work, except the parameters
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... needed to send emails, except your mail server connection details.

email.rst Outdated
* ``encryption`` (``tls``, or ``ssl``)
* ``auth_mode`` (``plain``, ``login``, or ``cram-md5``)
* ``spool``
# use this to disable the email delivery
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

... to disable email delivery

* ``delivery_addresses`` (an array of email addresses where to send ALL emails)
* ``disable_delivery`` (set to true to disable delivery completely)
# use this to send emails via Gmail (don't use this in production)
MAILER_URL=gmail://username:password@localhost
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we / should we delete the gmail.rst article now?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes! I'm proposing to remove two email articles: #8668.

Starting from SwiftMailer 5.4.5, the ``mail`` transport is deprecated
and will be removed in version 6. Consider using another transport like
``smtp``, ``sendmail`` or ``gmail``.
Refer to the :doc:`SwiftMailer configuration reference </reference/configuration/swiftmailer>`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there an easy example we could show for Mandrill, SendGrid or Amazon SES? I believe you basically use smtp, but point to their servers. But that might not obvious without an example.

And if we show that here, could we delete cloud.rst?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, let's do that when we remove the other articles.

@weaverryan
Copy link
Member

Status: Needs Work

@weaverryan weaverryan merged commit 9e10577 into symfony:master Nov 17, 2017
weaverryan added a commit that referenced this pull request Nov 17, 2017
…guiluz)

This PR was squashed before being merged into the master branch (closes #8652).

Discussion
----------

Updated the main email article to Symfony 4/Flex

Commits
-------

9e10577 Changes after Ryan's review (thanks!)
1732ccc Fixed a RST reference
5708a75 Updated the main email article to Symfony 4/Flex
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants