Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork5.2k
[Mailer] Documentrequire_tls
option#20701
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
[Mailer] Documentrequire_tls
option#20701
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Uh oh!
There was an error while loading.Please reload this page.
require_tls
optionThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
To have the same "naming" as the other versionadded directive when adding an new option
Uh oh!
There was an error while loading.Please reload this page.
mailer.rst Outdated
@@ -420,6 +420,29 @@ setting the ``auto_tls`` option to ``false`` in the DSN:: | |||
This setting only works when the ``smtp://`` protocol is used. | |||
Require use of TLS |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Maybe:
Require use of TLS | |
Enforce TLS |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Happy to change if preferred, butEnforce
feels slightly less accurate to me.Enforce
sounds like it'd change/force the connection in some manner and/or force TLS upon the whole connection process, whereas this option doesn't change the connection in any way, just ensures it's eventually used.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I understand your concern about the term "Enforce" and I agree with you.
What do you think about "Ensure TLS" instead? It might better reflect that the option guarantees the use of TLS without actively altering the connection.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
@Spomky Sorry for the late response. I agree that "Ensure TLS" would be better. I've updated the heading to that.
4cb9b50
to55217dc
Compare7d360e6
intosymfony:7.3Uh oh!
There was an error while loading.Please reload this page.
Dan, thanks a lot for providing these docs! Sorry it took us so long to merge it. Congrats on your first Symfony Docs contribution 🎉 |
For#20644. This PR documents the added SMTP
require_tls
option, as introduced insymfony/symfony#59479.I have referenced that this could throw a
TransportException
(where TLS is not achieved) but not sure if I should instead referenceTransportExceptionInterface
.