File tree Expand file tree Collapse file tree 2 files changed +9
-2
lines changed Expand file tree Collapse file tree 2 files changed +9
-2
lines changed Original file line number Diff line number Diff line change @@ -843,7 +843,7 @@ class << self
843
843
844
844
##
845
845
# :attr_reader: open_timeout
846
- # Seconds to wait until a connection is opened.
846
+ # Seconds to wait until a connection is opened. Also used by #starttls.
847
847
# Delegates to {config.open_timeout}[rdoc-ref:Config#open_timeout].
848
848
849
849
##
@@ -1341,6 +1341,10 @@ def logout!
1341
1341
# both successful. Any error indicates that the connection has not been
1342
1342
# secured.
1343
1343
#
1344
+ # After the server agrees to start a TLS connection, this method waits up to
1345
+ # {config.open_timeout}[rdoc-ref:Config#open_timeout] before raising
1346
+ # +Net::OpenTimeout+.
1347
+ #
1344
1348
# *Note:*
1345
1349
# >>>
1346
1350
# Any #response_handlers added before STARTTLS should be aware that the
Original file line number Diff line number Diff line change @@ -193,10 +193,13 @@ def self.[](config)
193
193
194
194
# Seconds to wait until a connection is opened.
195
195
#
196
+ # Applied separately for establishing TCP connection and starting a TLS
197
+ # connection.
198
+ #
196
199
# If the IMAP object cannot open a connection within this time,
197
200
# it raises a Net::OpenTimeout exception.
198
201
#
199
- # See Net::IMAP.new.
202
+ # See Net::IMAP.new and Net::IMAP#starttls .
200
203
#
201
204
# The default value is +30+ seconds.
202
205
attr_accessor :open_timeout , type : Integer
You can’t perform that action at this time.
0 commit comments