🗑️ Deprecate backward compatible parameters to new and starttls
#175
Conversation
This file contains hidden or 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
Collaborator
Author
|
FYI: the imap = Net::IMAP.new(settings[:address], settings[:port], settings[:enable_ssl], nil, false)Not only that, but it sets |
This was referenced Sep 19, 2023
nevans
force-pushed
the
deprecated-ssl-parameters
branch
from
af0faa5 to
5069f03
Compare
Converts `Net::IMAP#initialize` to use keyword parameters for all options. Creates `Net::IMAP::DeprecatedClientOptions`, which is prepended to `Net::IMAP` to override `#initialize`. Moved all of the original argument handling into it. Obsolete, but not yet deprecated: * Using an `options` hash instead of keyword parameters. * Sending `port` as the second parameter. Deprecated (will raise a warning): * Setting `ssl` params via `usessl`, `certs`, or `verify` arguments.
`Net::IMAP#starttls` converts all incoming keyword args in params for `OpenSSL::SSL::SSLContext#set_params`.
nevans
force-pushed
the
deprecated-ssl-parameters
branch
from
5069f03 to
2066e7f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Since 2007,
.newand#starttlshave taken an options hash (bad0027) and the original parameters have been undocumented (e631911). The originalusessl,certs, andverifyparameters will now print a deprecation warning whenever they are used. In a future release (no sooner than a year after 0.4.0 is released), they will be removed from both methods.The
optionshash has been converted to keyword parameters. An. sendingportas the second argument to#initializeis also obsolete. Neither of them will print a deprecation warning, but they will be marked as deprecated in a future release.To simplify the implementations of both
#initializeand#starttls, the backwards compatible parameters have all been extracted to aDeprecatedClientOptionsmodule, which is (currently) prepended toNet::IMAP.Note: #174 accidentally included rdoc references to
DeprecatedClientOptions, which is added by this PR.