Skip to content

Commit 432c720

Browse files
committed
Merge branch '5.4' into 6.0
* 5.4: Tell composer action is need to regenerate autoload Minor tweak Add a note about using Gmail vs an Email catcher
2 parents 0cf587a + b604dc1 commit 432c720

File tree

3 files changed

+25
-5
lines changed

3 files changed

+25
-5
lines changed

components/runtime.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -325,6 +325,9 @@ You can also configure ``extra.runtime`` in ``composer.json``:
325325
}
326326
}
327327
328+
Then, update your Composer files (running ``composer dump-autoload``, for instance),
329+
so that the ``vendor/autoload_runtime.php`` files gets regenerated with the new option.
330+
328331
The following options are supported by the ``SymfonyRuntime``:
329332

330333
``env`` (default: ``APP_ENV`` environment variable, or ``"dev"``)

configuration/override_dir_structure.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ define the ``runtime.dotenv_path`` option in the ``composer.json`` file:
4949
}
5050
}
5151
52-
Then, update your Composer files (running ``composer update``, for instance),
52+
Then, update your Composer files (running ``composer dump-autoload``, for instance),
5353
so that the ``vendor/autoload_runtime.php`` files gets regenerated with the new
5454
``.env`` path.
5555

mailer.rst

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ integration, CSS inlining, file attachments and a lot more. Get them installed w
1212
1313
$ composer require symfony/mailer
1414
15-
1615
.. _mailer-transport-setup:
1716

1817
Transport Setup
@@ -96,14 +95,13 @@ native ``native://default`` Mailer uses the sendmail
9695
Using a 3rd Party Transport
9796
~~~~~~~~~~~~~~~~~~~~~~~~~~~
9897

99-
Instead of using your own SMTP server or sendmail binary, you can send emails via a 3rd party
100-
provider. Mailer supports several - install whichever you want:
98+
Instead of using your own SMTP server or sendmail binary, you can send emails
99+
via a third-party provider:
101100

102101
================== ==============================================
103102
Service Install with
104103
================== ==============================================
105104
Amazon SES ``composer require symfony/amazon-mailer``
106-
Gmail ``composer require symfony/google-mailer``
107105
MailChimp ``composer require symfony/mailchimp-mailer``
108106
Mailgun ``composer require symfony/mailgun-mailer``
109107
Mailjet ``composer require symfony/mailjet-mailer``
@@ -113,6 +111,14 @@ Sendinblue ``composer require symfony/sendinblue-mailer``
113111
OhMySMTP ``composer require symfony/oh-my-smtp-mailer``
114112
================== ==============================================
115113

114+
.. note::
115+
116+
As a convenience, Symfony also provides support for Gmail (``composer
117+
require symfony/google-mailer``), but this should not be used in
118+
production. In development, you should probably use an :ref:`email catcher
119+
<mail-catcher>` instead. Note that most supported providers also offer a
120+
free tier.
121+
116122
Each library includes a :ref:`Symfony Flex recipe <symfony-flex>` that will add
117123
a configuration example to your ``.env`` file. For example, suppose you want to
118124
use SendGrid. First, install it:
@@ -1322,6 +1328,17 @@ is sent::
13221328
Development & Debugging
13231329
-----------------------
13241330

1331+
.. _mail-catcher:
1332+
1333+
Enabling an Email Catcher
1334+
~~~~~~~~~~~~~~~~~~~~~~~~~
1335+
1336+
When developing locally, it is recommended to use an email catcher. If you have
1337+
enabled Docker support via Symfony recipes, an email catcher is automatically
1338+
configured. In addition, if you are using the :doc:`Symfony local web server
1339+
</setup/symfony_server>`, the mailer DSN is automatically exposed via the
1340+
:ref:`symfony binary Docker integration <symfony-server-docker>`.
1341+
13251342
Disabling Delivery
13261343
~~~~~~~~~~~~~~~~~~
13271344

0 commit comments

Comments
 (0)