[Mailer] Document new Mailer transport options #13911
Conversation
|
May be it would be better to add |
|
Since |
components/mailer.rst
Outdated
| .. versionadded:: 5.2 | ||
|
|
||
| These options were added in Symfony 5.2. |
There was a problem hiding this comment.
This could be problematic if further options will be added, lets say in 5.3. I would recommend to remove this versionadded directive and do it like...
components/mailer.rst
Outdated
| Command to be executed by ``sendmail`` transport. | ||
|
|
||
| $dsn = 'sendmail://default?command=/usr/sbin/sendmail%20-oi%20-t' |
There was a problem hiding this comment.
| Command to be executed by ``sendmail`` transport. | |
| $dsn = 'sendmail://default?command=/usr/sbin/sendmail%20-oi%20-t' | |
| Command to be executed by ``sendmail`` transport. | |
| $dsn = 'sendmail://default?command=/usr/sbin/sendmail%20-oi%20-t' | |
| .. versionadded:: 5.2 | |
| The ``command`` option was introduced in Symfony 5.2. |
Please do this for the other options, too
components/mailer.rst
Outdated
| local_domain | ||
| ~~~~~~~~~~~~ | ||
|
|
||
| The domain name to use in ``HELO`` command. |
There was a problem hiding this comment.
| The domain name to use in ``HELO`` command. | |
| The domain name to use in ``HELO`` command:: |
Can you explain to me what HELO is? Maybe we could add a link to a wikipedia page or sth. else?
There was a problem hiding this comment.
You mean like https://en.wikipedia.org/wiki/Simple_Mail_Transfer_Protocol#SMTP_transport_example? That's were "HELO" links to from other pages on Wikipedia at least.
components/mailer.rst
Outdated
| ~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The maximum number of messages to send before re-starting the transport. Can be | ||
| used together with ``restart_threshold_sleep`` which is the number of seconds to |
There was a problem hiding this comment.
This option is not documented, isn't it? 🤔
There was a problem hiding this comment.
Indeed, I'll ammend it with the other changes.
|
@OskarStark I'll wait for #14083 to be merged, before I make any changes, since the whole thing needs to be restructured then anyway. |
… (fritzmg) This PR was squashed before being merged into the 5.2-dev branch. Discussion ---------- [Mailer] Implement additional mailer transport options | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #37300 | License | MIT | Doc PR | symfony/symfony-docs#13911 This implements additional transport configuration options mentioned in #37300. It also adds a `command` option to be able to define the command used by the `sendmail` transport. Examples: ```yml framework: mailer: transports: sendmail: sendmail://default?command=/usr/sbin/sendmail%%20-oi%%20-t local_domain: smtps://smtp.example.com?local_domain=example.org restart_threshold: smtps://smtp.example.com?restart_threshold=10&restart_threshold_sleep=1 ping_threshold: smtps://smtp.example.com?ping_threshold=200 ``` Commits ------- 665d1cd [Mailer] Implement additional mailer transport options
|
Can you please rebase? Thanks |
96b8ba8 to
f713212
Compare
|
Thanks for contributing these docs! We changed them a bit and fixed the conflicts while merging. Congrats on your first Symfony Docs contribution! |
|
Sorry, completely dropped off my radar :) |
… (fritzmg) This PR was squashed before being merged into the 5.2-dev branch. Discussion ---------- [Mailer] Implement additional mailer transport options | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #37300 | License | MIT | Doc PR | symfony/symfony-docs#13911 This implements additional transport configuration options mentioned in #37300. It also adds a `command` option to be able to define the command used by the `sendmail` transport. Examples: ```yml framework: mailer: transports: sendmail: sendmail://default?command=/usr/sbin/sendmail%%20-oi%%20-t local_domain: smtps://smtp.example.com?local_domain=example.org restart_threshold: smtps://smtp.example.com?restart_threshold=10&restart_threshold_sleep=1 ping_threshold: smtps://smtp.example.com?ping_threshold=200 ``` Commits ------- 665d1cd3fa [Mailer] Implement additional mailer transport options
This documents the additional options for the Mailer component introduced in symfony/symfony#37432