8000 Update Swiftmailer configuration docs by jverdeyen · Pull Request #7152 · symfony/symfony-docs · GitHub
[go: up one dir, main page]
Skip to content

Update Swiftmailer configuration docs #7152

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 9 commits into from
Closed

Update Swiftmailer configuration docs #7152

wants to merge 9 commits into from

Conversation

jverdeyen
Copy link
Contributor

Added delivery_addresses configuration.

@javiereguiluz
Copy link
Member

@jverdeyen thanks for documenting this missing option. Looking at the code of Swiftmailer, we can see the following:

The swiftmailer.delivery_address configuration key is deprecated since version 2.3.10
and will be removed in 3.0. Use the swiftmailer.delivery_addresses configuration key
instead (or remove the empty setting).

So I guess we should also do the following:

  • Remove the description of the delivery_address option in 3.* docs
  • Add a warning message in 3.* docs telling that _addresses was previously called _address
  • Remove in the Symfony code this _address option

@jverdeyen
Copy link
Contributor Author

Updated!

@javiereguiluz
Copy link
Member

I was going to create a new issue in the Symfony repo to mention the delivery_address deprecation ... but then I remembered that SwiftMailerBundle is one of the "built-in" bundles that is not really built-in ... so the 2.3.10 and 3.0 versions mentioned by the deprecation refer to SwiftMailerBundle versions and not Symfony versions.

If that's correct, my previous comment was completely wrong and we should revert the b34d046 commit. I'm really sorry.

@jverdeyen
Copy link
Contributor Author

So both delivery_address and delivery_addresses are valid in 3.* ?

@javiereguiluz
Copy link
Member

@jverdeyen yes, because even the master branch in the Symfony Standard edition requires this:

"symfony/swiftmailer-bundle": "^2.3",

See https://github.com/symfony/symfony-standard/blob/master/composer.json#L19

@jverdeyen
Copy link
Contributor Author

@javiereguiluz Updated!

@javiereguiluz
Copy link
Member

👍

@jverdeyen thanks for completing this and sorry for having given you wrong directions in my previous comments.

@jverdeyen
Copy link
Contributor Author

@javiereguiluz No problem!

stof
stof reviewed Nov 28, 2016
View reviewed changes
email/dev_environment.rst
@@ -53,12 +53,12 @@ will not be sent when you run tests, but will continue to be sent in the
If you'd also like to disable deliver in the ``dev`` environment, simply
add this same configuration to the ``config_dev.yml`` file.

Sending to a Specified Address
Sending to a Specified Address(es)
------------------------------
Copy link
Member

Choose a reason for hiding this comment

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

you need to make the underlining longer here as the title is longer

@stof
Copy link
Member
stof commented Nov 28, 2016

@javiereguiluz but the policy was to avoid documenting deprecated features though, so the doc should describe only the new way IMO

@javiereguiluz
Copy link
Member

@jverdeyen I've updated your pull request to remove any mention to the deprecated delivery_address option. I did this myself because I don't want to make you waste more time on this :)

I have a question for XML config experts (@xabbug, @wouterj) How can I define the delivery_addresses config as an array in XML? Thanks!

@xabbuh
Copy link
Member
xabbuh commented Nov 29, 2016

@javiereguiluz You wil define several delivery-address element nodes (see https://github.com/symfony/swiftmailer-bundle/blob/master/Resources/config/schema/swiftmailer-1.0.xsd#L17)

javiereguiluz
javiereguiluz reviewed Nov 29, 2016
View reviewed changes
reference/configuration/swiftmailer.rst
@@ -235,7 +236,6 @@ Full Default Configuration
auth_mode=""
sender_address=""
delivery_address=""
Copy link
Member

Choose a reason for hiding this comment

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

Should this delivery_address option be removed to?

Copy link
Member

Choose a reason for hiding this comment

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

done

@jverdeyen
Copy link
Contributor Author

Any update?

@xabbuh
Copy link
Member
xabbuh commented Dec 12, 2016

Thank you @jverdeyen.

xabbuh added a commit that referenced this pull request Dec 12, 2016
@xabbuh
minor #7152 Update Swiftmailer configuration docs (jverdeyen, javiere…
67b763e 
…guiluz, xabbuh)

This PR was submitted for the master branch but it was merged into the 2.7 branch instead (closes #7152).

Discussion
----------

Update Swiftmailer configuration docs

Added `delivery_addresses` configuration.

Commits
-------

bbc673a add missing dot at the end of sentence
45cbc55 add labels for old headlines
2c97e50 delivery adresses are separate XML element nodes
daaa24a Removed the description of the deprecated `delivery_address` option
55c38a6 Removed any mention of the deprecated delivery_address option
ea508f9 Removed the mention to the deprecated delivery_address option
56f6f53 Fixed a minor syntax issue
2f58823 Fixed a minor syntax issue
660aaa1 Update Swiftmailer configuration docs
@xabbuh xabbuh closed this Dec 12, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@javiereguiluz javiereguiluz javiereguiluz left review comments

@stof stof stof left review comments

@xabbuh xabbuh xabbuh left review comments

Assignees
No one assigned
Labels
Status: Reviewed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jverdeyen @javiereguiluz @stof @xabbu 336E h @carsonbot
0