Skip to content

Commit 042c757

Browse files
committed
Merge branch '6.2' into 6.3
* 6.2: [Mailer] Add a note about how to use the Gmail provider
2 parents c41acf9 + 4c8ec4a commit 042c757

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
@@ -167,7 +167,7 @@ party provider:
167167
Provider SMTP HTTP API
168168
==================== ==================================================== =========================================== ========================================
169169
Amazon SES ses+smtp://USERNAME:PASSWORD@default ses+https://ACCESS_KEY:SECRET_KEY@default ses+api://ACCESS_KEY:SECRET_KEY@default
170-
Google Gmail gmail+smtp://USERNAME:PASSWORD@default n/a n/a
170+
Google Gmail gmail+smtp://USERNAME:APP-PASSWORD@default n/a n/a
171171
Mailchimp Mandrill mandrill+smtp://USERNAME:PASSWORD@default mandrill+https://KEY@default mandrill+api://KEY@default
172172
Mailgun mailgun+smtp://USERNAME:PASSWORD@default mailgun+https://KEY:DOMAIN@default mailgun+api://KEY:DOMAIN@default
173173
Mailjet mailjet+smtp://ACCESS_KEY:SECRET_KEY@default n/a mailjet+api://ACCESS_KEY:SECRET_KEY@default
@@ -196,6 +196,15 @@ Infobip infobip+smtp://KEY@default n/a
196196
When using SMTP, the default timeout for sending a message before throwing an
197197
exception is the value defined in the `default_socket_timeout`_ PHP.ini option.
198198

199+
.. note::
200+
201+
To use Google Gmail, you must have a Google Account with 2-Step-Verification (2FA)
202+
enabled and you must use `App Password`_ to authenticate. Also note that Google
203+
revokes your App Passwords when you change your Google Account password and then
204+
you need to generate a new one.
205+
Using other methods (like ``XOAUTH2`` or the ``Gmail API``) are not supported currently.
206+
You should use Gmail for testing purposes only and use a real provider in production.
207+
199208
.. tip::
200209

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

0 commit comments

Comments
 (0)