Current File : //proc/thread-self/root/proc/self/root/opt/alt/ruby18/share/ri/1.8/system/Net/IMAP/new-c.yaml |
--- !ruby/object:RI::MethodDescription
aliases: []
block_params:
comment:
- !ruby/struct:SM::Flow::P
body: Creates a new Net::IMAP object and connects it to the specified <tt>port</tt> (143 by default) on the named <tt>host</tt>. If <tt>usessl</tt> 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. The <tt>certs</tt> parameter indicates the path or file containing the CA cert of the server, and the <tt>verify</tt> parameter is for the OpenSSL verification callback.
- !ruby/struct:SM::Flow::P
body: "The most common errors are:"
- !ruby/object:SM::Flow::LIST
contents:
- !ruby/struct:SM::Flow::LI
label: "Errno::ECONNREFUSED:"
body: connection refused by <tt>host</tt> or an intervening firewall.
- !ruby/struct:SM::Flow::LI
label: "Errno::ETIMEDOUT:"
body: connection timed out (possibly due to packets being dropped by an intervening firewall).
- !ruby/struct:SM::Flow::LI
label: "Errno::ENETUNREACH:"
body: there is no route to that network.
- !ruby/struct:SM::Flow::LI
label: "SocketError:"
body: hostname not known or other socket error.
- !ruby/struct:SM::Flow::LI
label: "Net::IMAP::ByeResponseError:"
body: we connected to the host, but they immediately said goodbye to us.
type: :NOTE
full_name: Net::IMAP::new
is_singleton: true
name: new
params: (host, port = PORT, usessl = false, certs = nil, verify = false)
visibility: public