Skip to content

Commit 62d62ff

Browse files
committed
[Mailer] Add a note about how to use the Gmail provider
1 parent 97486b7 commit 62d62ff

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

mailer.rst

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ party provider:
177177
Provider SMTP HTTP API
178178
==================== ==================================================== =========================================== ========================================
179179
Amazon SES ses+smtp://USERNAME:PASSWORD@default ses+https://ACCESS_KEY:SECRET_KEY@default ses+api://ACCESS_KEY:SECRET_KEY@default
180-
Google Gmail gmail+smtp://USERNAME:PASSWORD@default n/a n/a
180+
Google Gmail gmail+smtp://USERNAME:APP-PASSWORD@default n/a n/a
181181
Mailchimp Mandrill mandrill+smtp://USERNAME:PASSWORD@default mandrill+https://KEY@default mandrill+api://KEY@default
182182
Mailgun mailgun+smtp://USERNAME:PASSWORD@default mailgun+https://KEY:DOMAIN@default mailgun+api://KEY:DOMAIN@default
183183
Mailjet mailjet+smtp://ACCESS_KEY:SECRET_KEY@default n/a mailjet+api://ACCESS_KEY:SECRET_KEY@default
@@ -214,6 +214,15 @@ OhMySMTP ohmysmtp+smtp://API_TOKEN@default n/a
214214
The usage of ``default_socket_timeout`` as the default timeout was
215215
introduced in Symfony 5.1.
216216

217+
.. note::
218+
219+
To use Google Gmail, you must have a Google Account with 2-Step-Verification (2FA)
220+
enabled and you must use `App Password`_ to authenticate. Also note that Goglle
221+
revokes your App Passwords when you change your Google Account password and then
222+
you need to generate a new one.
223+
Using other methods (like ``XOAUTH2`` or the ``Gmail API``) are not supported currenty.
224+
You should use Gmail for testing purposes only and use a real provider in production.
225+
217226
.. tip::
218227

219228
If you want to override the default host for a provider (to debug an issue using
@@ -1564,3 +1573,4 @@ you can use the built in assertions::
15641573
.. _`PEM encoded`: https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail
15651574
.. _`default_socket_timeout`: https://www.php.net/manual/en/filesystem.configuration.php#ini.default-socket-timeout
15661575
.. _`RFC 3986`: https://www.ietf.org/rfc/rfc3986.txt
1576+
.. _`App Password`: https://support.google.com/accounts/answer/185833

0 commit comments

Comments
 (0)