1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

* lib/net/imap.rb (initialize): fixed documentation.

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@14468 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
shugo 2007-12-22 06:05:14 +00:00
parent a7ef0c7303
commit 482690cdf8
2 changed files with 12 additions and 12 deletions

View file

@ -1,3 +1,7 @@
Sat Dec 22 15:03:37 2007 Shugo Maeda <shugo@ruby-lang.org>
* lib/net/imap.rb (initialize): fixed documentation.
Sat Dec 22 15:01:16 2007 Shugo Maeda <shugo@ruby-lang.org>
* lib/net/pop.rb (enable_ssl): use OpenSSL::SSL::SSLContext.build

View file

@ -876,28 +876,24 @@ module Net
@@debug = false
@@authenticators = {}
# Creates a new Net::IMAP object and connects it to the specified
# port (143 by default) on the named +host+.
# call-seq:
# Net::IMAP.new(host, options = {})
#
# If +port_or_options+ responds to to_int, it is used as port number.
# Otherwise +port_or_options+ is an option hash.
# Creates a new Net::IMAP object and connects it to the specified
# +host+.
#
# +options+ is an option hash.
#
# The available options are:
#
# :port:: port number (default value is 143 for imap, or 993 for imaps)
# :ssl:: if port_or_options[:ssl] is true, then an attempt will be made
# :ssl:: if +options[:ssl]+ is true, then an attempt will be made
# to use SSL (now TLS) to connect to the server. For this to work
# OpenSSL [OSSL] and the Ruby OpenSSL [RSSL] extensions need to
# be installed.
# if port_or_options[:ssl] is a hash, it's passed to
# if +options[:ssl]+ is a hash, it's passed to
# OpenSSL::SSL::SSLContext.build as parameters.
#
# +usessl+, +certs+, and +verify+ are for backward compatibility.
# If +usessl+ is true, then an attempt will be made to use SSL (now TLS)
# to connect to the server. The +certs+ parameter indicates
# the path or file containing the CA cert of the server, and the
# +verify+ parameter is for the OpenSSL verification callback.
#
# The most common errors are:
#
# Errno::ECONNREFUSED:: connection refused by +host+ or an intervening