Skip to content

Commit c6556a3

Browse files
committed
Merge branch '6.0' into 6.1
* 6.0: [Mailer] Add a note about how to use the Gmail provider
2 parents c8946c2 + d09485d commit c6556a3

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
@@ -160,7 +160,7 @@ party provider:
160160
Provider SMTP HTTP API
161161
==================== ==================================================== =========================================== ========================================
162162
Amazon SES ses+smtp://USERNAME:PASSWORD@default ses+https://ACCESS_KEY:SECRET_KEY@default ses+api://ACCESS_KEY:SECRET_KEY@default
163-
Google Gmail gmail+smtp://USERNAME:PASSWORD@default n/a n/a
163+
Google Gmail gmail+smtp://USERNAME:APP-PASSWORD@default n/a n/a
164164
Mailchimp Mandrill mandrill+smtp://USERNAME:PASSWORD@default mandrill+https://KEY@default mandrill+api://KEY@default
165165
Mailgun mailgun+smtp://USERNAME:PASSWORD@default mailgun+https://KEY:DOMAIN@default mailgun+api://KEY:DOMAIN@default
166166
Mailjet mailjet+smtp://ACCESS_KEY:SECRET_KEY@default n/a mailjet+api://ACCESS_KEY:SECRET_KEY@default
@@ -188,6 +188,15 @@ OhMySMTP ohmysmtp+smtp://API_TOKEN@default n/a
188188
When using SMTP, the default timeout for sending a message before throwing an
189189
exception is the value defined in the `default_socket_timeout`_ PHP.ini option.
190190

191+
.. note::
192+
193+
To use Google Gmail, you must have a Google Account with 2-Step-Verification (2FA)
194+
enabled and you must use `App Password`_ to authenticate. Also note that Google
195+
revokes your App Passwords when you change your Google Account password and then
196+
you need to generate a new one.
197+
Using other methods (like ``XOAUTH2`` or the ``Gmail API``) are not supported currently.
198+
You should use Gmail for testing purposes only and use a real provider in production.
199+
191200
.. tip::
192201

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

0 commit comments

Comments
 (0)