new(host, port: nil, ssl: nil, response_handlers: nil, config: Net::IMAP::Config.global, **config_options) -> 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 に接続します。response_handlersには受信スレッドを開始する前に追加する応答ハンドラのリストを指定します。こうすると最初の応答(Net::IMAP#greeting)も含めて、サーバからのすべての応答がハンドラで処理されます。configには接続の設定(Net::IMAP::Config オブジェクト)を指定します。設定のほかに、版の数値(0.4など)や名前(:currentなど)やハッシュも Net::IMAP::Config.[] と同じように指定できます。これは接続ごとに作られる設定(Net::IMAP#config)を直接置き換えるのではなく、その継承元になります。省略時は全体の設定 Net::IMAP::Config.global が継承元になります。残りのキーワード引数config_optionsは Net::IMAP::Config.new に渡され、接続ごとの設定の初期値になります。たとえばopen_timeout(接続が確立するまで待つ秒数。既定値は 30)やidle_response_timeout(IDLE の応答を待つ秒数。既定値は 5)を指定できます。互換性のため、
例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 })この警告は
Warning[:deprecated]が真のとき(-W:deprecatedを指定したときなど)だけ表示されます。- [PARAM]
host: - 接続するホスト名の文字列
- [PARAM]
port: - 接続するポート番号
- [PARAM]
ssl: - 真で SSL/TLS を使う。ハッシュなら OpenSSL::SSL::SSLContext#set_params に渡すパラメータ(ハッシュでない真の値は既定のパラメータ)
- [PARAM]
response_handlers: - 受信スレッドを開始する前に追加する応答ハンドラのリスト
- [PARAM]
config: - 接続ごとの設定の継承元とする Net::IMAP::Config オブジェクト。版の数値や名前やハッシュも指定できます
- [PARAM]
config_options: -
接続ごとの設定の初期値(
open_timeoutなど) - [EXCEPTION]
ArgumentError: -
互換のための形の引数とキーワード引数を同時に渡した場合や、
optionsのハッシュとusesslなどを同時に渡した場合に発生します
- [PARAM]