Skip to content

[SwiftMailer] Update future reference #7510

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

Merged
merged 6 commits into from
Apr 28, 2017

Conversation

mykiwi
Copy link
Contributor

@mykiwi mykiwi commented Feb 17, 2017

@@ -191,6 +225,13 @@ logging
If true, Symfony's data collector will be activated for Swift Mailer and
the information will be available in the profiler.

.. tip::

The following configuration can used environment variable:
Copy link
Member

Choose a reason for hiding this comment

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

The following configuration options are compatible with %env()% parameters (with link to doc about them?)

@mykiwi mykiwi force-pushed the update-swift-mailer branch 2 times, most recently from e769f16 to 3b45d89 Compare February 17, 2017 23:53
@mykiwi mykiwi force-pushed the update-swift-mailer branch from 3b45d89 to 287b71f Compare February 17, 2017 23:57

**type**: ``string``

The URL to configure swift mailer.
Copy link
Member

Choose a reason for hiding this comment

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

Swiftmailer

Copy link
Member

Choose a reason for hiding this comment

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

"The URL" doesn't look precise enough to me. What about "The URL describing the mail server to connect with"?

@javiereguiluz javiereguiluz changed the title [SwiftMailer] Update futur reference [SwiftMailer] Update future reference Feb 19, 2017
Copy link
Member

@javiereguiluz javiereguiluz left a comment

Choose a reason for hiding this comment

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

👍

@mykiwi thanks a lot for this! Your contribution was great, but I've proposed some minor tweaks on top of it. Thanks!

@mykiwi mykiwi force-pushed the update-swift-mailer branch from 619f626 to 635a0ab Compare February 23, 2017 12:19
fabpot added a commit to symfony/swiftmailer-bundle that referenced this pull request Feb 23, 2017
…kiwi)

This PR was merged into the 2.5-dev branch.

Discussion
----------

allow using env variables in transport configuration

Example:
```yml
# MAILER_URL=transport://user:pass@host:port/?encryption=...&auth_mode=...
swiftmailer:
    url: "%env(MAILER_URL)%"
```

To do:

- [x] add the doc symfony/symfony-docs/pull/7510
- [x] add tests

Commits
-------

183b291 allow using env variables in transport configuration
@@ -37,6 +41,15 @@ Configuration
* `disable_delivery`_
* `logging`_

url
~~~

Copy link
Contributor

Choose a reason for hiding this comment

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

Missing version added? (same for other options below)


**type**: ``string``

The entire SwiftMailer configuration using a DSN-like URL format.
Copy link
Contributor

Choose a reason for hiding this comment

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

"using" => "uses"

Copy link
Member

Choose a reason for hiding this comment

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

I think "using" is correct here. We're not saying that Swift "uses" this ... but that the "url" option is all the Swift config using a DSN format.

@@ -97,20 +100,29 @@ timeout

**type**: ``integer``

.. versionadded:: 2.4.2
The ``url`` option was added in SwiftMailerBundle 2.4.2.
Copy link
Contributor

Choose a reason for hiding this comment

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

The parameter looks wrong here and below.

Copy link
Member

Choose a reason for hiding this comment

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

😭 it's fixed now!

The following configuration options are compatible with ``%env()%`` parameters:
``url``, ``transport``, ``username``, ``password``, ``host``,
``port``, ``timeout``, ``source_ip``, ``local_domain``,
``encryption``, ``auth_mode``.
Copy link
Contributor

Choose a reason for hiding this comment

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

Considering symfony/swiftmailer-bundle#159 (comment), we should remove these two parameters for now, wdyt?

Copy link
Contributor

@HeahDude HeahDude left a comment

Choose a reason for hiding this comment

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

@javiereguiluz
Copy link
Member

Merging it because the related PR was already merged. Thanks Romain!

@javiereguiluz javiereguiluz merged commit 6aa0117 into symfony:master Apr 28, 2017
javiereguiluz added a commit that referenced this pull request Apr 28, 2017
…luz)

This PR was merged into the master branch.

Discussion
----------

[SwiftMailer] Update future reference

- [x] Require symfony/swiftmailer-bundle#159

Commits
-------

6aa0117 Removed "encryption" and "auth_mode" from the list of %env()% compatible options
76ce6af Fixed ... again ... the versionadded directives
ef7536c Added the missing "versionadded" directives
635a0ab add mail transport as deprecated
54ad41c Minor tweaks
287b71f update swiftmailer reference
xabbuh added a commit that referenced this pull request May 4, 2017
…uiluz, xabbuh)

This PR was merged into the 2.7 branch.

Discussion
----------

Backport #7510 for the Symfony 2.7 docs

All the documented options are part of SwiftmailerBundle releases that are compatible with Symfony 2.7.

Commits
-------

1c39991 fix versionadded directives
8eaccef Removed "encryption" and "auth_mode" from the list of %env()% compatible options
3395258 Fixed ... again ... the versionadded directives
3333723 Added the missing "versionadded" directives
0e2853a add mail transport as deprecated
2bd1a22 Minor tweaks
b161bd8 update swiftmailer reference
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.

6 participants