Ruby 3.3 リファレンスマニュアル

singleton method Net::IMAP.new

new(host, port: nil, ssl: nil, open_timeout: 30, idle_response_timeout: 5) -> Net::IMAP[permalink][rdoc][edit]

新たな Net::IMAP オブジェクトを生成し、指定したホストの指定したポートに接続し、接続後の IMAP オブジェクトを返します。

ssl に真を渡すと、サーバに繋ぐのに SSL/TLS を用います。 ssl がハッシュならば、それを OpenSSL::SSL::SSLContext#set_params に渡して SSL/TLS のパラメータを設定します。ハッシュでない真の値(true など)ならば、空のハッシュを渡したのと同じで、OpenSSL::SSL::SSLContext#set_params の既定のパラメータを使います。ハッシュへの変換は Hash.try_convert で行うので、to_hash を持つオブジェクトもハッシュとして扱います。 SSL/TLS での接続には OpenSSL と openssl が使える必要があります。 port を省略すると、SSL/TLS を使うときは 993、使わないときは 143 に接続します。

open_timeout で接続が確立するまで待つ秒数を、idle_response_timeout で IDLE の応答を待つ秒数を指定します。

互換性のため、Net::IMAP.new(host, port) と Net::IMAP.new(host, options)(options はハッシュ)の形も受け付けます。それぞれ port を port: のキーワード引数に、options をキーワード引数に変換し、警告は出ません。 Net::IMAP.new(host, port, usessl, certs, verify) の形は非推奨で、警告を出します。 usessl が偽ならば certs と verify は無視され、SSL/TLS を使いません。 usessl が真ならば certs と verify を ssl のハッシュに変換します。 certs がファイルならば ca_file に、ディレクトリならば ca_path に変換し、verify が真ならば verify_mode に OpenSSL::SSL::VERIFY_PEER を、偽ならば OpenSSL::SSL::VERIFY_NONE を設定します。

例
require 'net/imap'

imap = Net::IMAP.new('imap.example.com', port: 993,
                     ssl: { verify_mode: OpenSSL::SSL::VERIFY_PEER,
                            timeout: 600 })
[PARAM] host:
接続するホスト名の文字列
[PARAM] port:
接続するポート番号
[PARAM] ssl:
真で SSL/TLS を使う。ハッシュなら OpenSSL::SSL::SSLContext#set_params に渡すパラメータ(ハッシュでない真の値は既定のパラメータ)
[PARAM] open_timeout:
接続が確立するまで待つ秒数
[PARAM] idle_response_timeout:
IDLE の応答を待つ秒数
[EXCEPTION] ArgumentError:
互換のための形の引数とキーワード引数を同時に渡した場合や、options のハッシュと usessl などを同時に渡した場合に発生します