Skip to content
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

Reworded the "How to use Gmail" cookbook article #5856

Closed
wants to merge 5 commits into from

Conversation

javiereguiluz
Copy link
Member

Q A
Doc fix? yes
New docs? no
Applies to all
Fixed tickets -

In StackOverflow some people are having issues with the encryption parameter of Gmail. And others are having issues with Gmail + SwiftMailerBundle.

That's why I propose to reword this article and explain some things with more detail.

@@ -55,33 +50,73 @@ In the development configuration file, change the ``transport`` setting to
'password' => 'your_gmail_password',
));

You're done!
If you are using the Symfony Standard Edition, it's more convenient to configure
these parameters in ``parameters.yml``:
Copy link
Member

Choose a reason for hiding this comment

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

"these parameters" seems wrong, as we never talked about parameters before in this article. What about: "If you're using the Symfony Standard Edition, it's more convenient to use parameters for these options:"

Copy link
Contributor

Choose a reason for hiding this comment

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

...to use parameters.yml for these options...?

.. note::
The ``gmail`` transport is simply a shortcut that uses the ``smtp`` transport
and sets ``encryption`` to ``ssl``, ``auth_mode`` to ``login`` and ``host`` to
``smtp.gmail.com`` to work with Gmail.
Copy link
Contributor

Choose a reason for hiding this comment

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

what about using a table here for the options?

@OskarStark
Copy link
Contributor

Great work @javiereguiluz

@javiereguiluz
Copy link
Member Author

I've changed everything I was asked for. Time for another review. Thanks.

@OskarStark
Copy link
Contributor

nice 👍


The ``gmail`` transport is simply a shortcut that uses the ``smtp`` transport
and sets ``encryption``, ``auth_mode`` and ``host`` to work with Gmail.
If you are using 2-Step-Verification, you must `generate an App password`_ and use this as your ``mailer_password`` value.
Copy link
Member

Choose a reason for hiding this comment

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

looks like you forgot to wrap the sentence :)

@javiereguiluz
Copy link
Member Author

I've implemented the last round of fixes. Please tell me that this is ready for the merge 😌

within your app. If your Gmail account uses 2-Step-Verification, you should
`generate an App password`_ to use for your ``mailer_password`` parameter.
You should also ensure that you `allow less secure apps to access your Gmail account`_.
:doc:`Swiftmailer configuration reference </reference/configuration/swiftmailer>`
Copy link
Member

Choose a reason for hiding this comment

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

I would have kept the sentence though:

.. seealso::

    See the :doc:`Swiftmailer configuration reference </reference/configuration/swiftmailer>`
    for more details.

Copy link
Member

Choose a reason for hiding this comment

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

But we can make that change when merging. The PR so far looks ready to me. 👍

wouterj added a commit that referenced this pull request Feb 6, 2016
…reguiluz)

This PR was squashed before being merged into the 2.3 branch (closes #5856).

Discussion
----------

Reworded the "How to use Gmail" cookbook article

| Q             | A
| ------------- | ---
| Doc fix?      | yes
| New docs?     | no
| Applies to    | all
| Fixed tickets | -

In StackOverflow some people are [having issues](http://stackoverflow.com/questions/33226583/swiftmailer-doesnt-work/33240538#33240538) with the `encryption` parameter of Gmail. And others are [having issues](symfony/swiftmailer-bundle#106) with Gmail + SwiftMailerBundle.

That's why I propose to reword this article and explain some things with more detail.

Commits
-------

b113f72 Reworded the "How to use Gmail" cookbook article
wouterj added a commit that referenced this pull request Feb 6, 2016
@wouterj
Copy link
Member

wouterj commented Feb 6, 2016

Thank you @javiereguiluz! I've merged your PR and applied the final 2 comments in 6c07b60

@wouterj wouterj closed this Feb 6, 2016
@javiereguiluz javiereguiluz deleted the tweak_gmail_cookbook branch May 24, 2018 16:00
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.

None yet

4 participants