[Mailer] Document require_tls option
#20701
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
OskarStark
reviewed
Mar 10, 2025
OskarStark
changed the title
require_tls option
As requested by OskarStark.
Co-authored-by: Maxime Doutreluingne <[email protected]>
xabbuh
reviewed
Mar 24, 2025
| @@ -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.
Maybe:
Suggested change
| Require use of TLS | |
| Enforce TLS |
There was a problem hiding this comment.
Happy to change if preferred, but Enforce 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.
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.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For #20644. This PR documents the added SMTP
require_tlsoption, as introduced in symfony/symfony#59479.I have referenced that this could throw a
TransportException(where TLS is not achieved) but not sure if I should instead referenceTransportExceptionInterface.