Skip to content

Update gmail.rst #5085

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

Closed
wants to merge 3 commits into from
Closed

Update gmail.rst #5085

wants to merge 3 commits into from

Conversation

ghost
Copy link

@ghost ghost commented Mar 16, 2015

There are issues with the current docs as they don't address certain user configurations that prevent Symfony from emailing from their app. Mentioning two factor authentication and the less secure app setting is in my opinion, paramount.

Reference: http://stackoverflow.com/q/29085617/1188035

There are issues with the current docs as they don't address certain user configurations that prevent Symfony from emailing from their app. Mentioning two factor authentication and the less secure app setting is in my opinion, paramount.

Reference: http://stackoverflow.com/q/29085617/1188035

Depending on your Gmail account settings, you may get authentication errors within your app.
You should ensure two-factor authentication and [also allow less secure apps to access your
account](https://support.google.com/accounts/answer/6010255)
Copy link
Member

Choose a reason for hiding this comment

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

this is markdown syntax, while this docs is writting in reStructured Text. Please update this PR to use that syntax:

.. note::

    Depending on your Gmail account settings, you may get authentication errors within your app.
    You should ensure two-factor authentication and 
    `also allow less secure apps to access your account`_.

.. _`also allow less secure apps to access your account`: https://support.google.com/accounts/answer/6010255

@javiereguiluz
Copy link
Member

@sjagr thanks for proposing this improvement!

I have a question for you regarding this phrase:

You should ensure two-factor authentication [...]

I don't really understand what does it mean. Maybe we could change it for one of these alternatives:

  • You should enable two-factor authentication [...]
  • You should ensure that two-factor authentication is enabled [...]

schuylr added 2 commits March 25, 2015 14:45
Revisions concerning the 2-Step-Verification and correct documentation syntax. Thanks @wouterj and @javiereguiluz
@ghost
Copy link
Author

ghost commented Mar 25, 2015

Thanks @wouterj for the format corrections.
@javiereguiluz Obviously a brain-fart on my part. I've made it much clearer and added a reference to Google Help for better understanding.

There can be an alternative suggestion of just turning 2-Step-Verification completely off, but I figured a Gmail user with that setting enabled (such as me) would want to leave it on.

@javiereguiluz
Copy link
Member

This pull request looks finished. If that's true, can we please remove the In progress label? Thanks.


Depending on your Gmail account settings, you may get authentication errors within your app.
If your Gmail account uses 2-Step-Verification, you should `generate an App password`_ to use for your
``mailer_password`` parameter.
Copy link
Member

Choose a reason for hiding this comment

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

There is no need for this line break. Can you also please wrap lines after the first word that crosses the 72nd character instead?

@javiereguiluz
Copy link
Member

I'm finishing this PR in #5430.

@sjagr don't worry about not having finished your PR. This happens sometimes. I've taken your work and finished it in another PR. I've also reused all your original commits so you get full credit for your work. Thanks.

@xabbuh
Copy link
Member

xabbuh commented Jun 23, 2015

Thank you for starting this @sjagr!

@xabbuh xabbuh closed this Jun 23, 2015
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.

4 participants