diff options
author | shugo <shugo@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2007-12-22 06:05:14 +0000 |
---|---|---|
committer | shugo <shugo@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2007-12-22 06:05:14 +0000 |
commit | 482690cdf88158e62efb9ea3f5bea5f1a7bf7346 (patch) | |
tree | cb72c64ae3e0bb20b78986e5e3398a041551279b /lib | |
parent | a7ef0c7303ed6faa4ca5eac73077d6ec5e2ee285 (diff) | |
download | ruby-482690cdf88158e62efb9ea3f5bea5f1a7bf7346.tar.gz |
* lib/net/imap.rb (initialize): fixed documentation.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@14468 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib')
-rw-r--r-- | lib/net/imap.rb | 18 |
1 files changed, 7 insertions, 11 deletions
diff --git a/lib/net/imap.rb b/lib/net/imap.rb index 688ab2ff49..117f740d52 100644 --- a/lib/net/imap.rb +++ b/lib/net/imap.rb @@ -876,28 +876,24 @@ module Net @@debug = false @@authenticators = {} + # call-seq: + # Net::IMAP.new(host, options = {}) + # # Creates a new Net::IMAP object and connects it to the specified - # port (143 by default) on the named +host+. + # +host+. # - # If +port_or_options+ responds to to_int, it is used as port number. - # Otherwise +port_or_options+ is an option hash. + # +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 |