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などを同時に渡した場合に発生します
- [PARAM]