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

instance method Net::IMAP#starttls

starttls(**options) -> Net::IMAP::TaggedResponseRuby 1.9.3 から[permalink][rdoc][edit]

STARTTLS コマンドを送って TLS のセッションを開始します。

キーワード引数 options は OpenSSL::SSL::SSLContext#set_params にそのまま渡されます。キーは OpenSSL::SSL::SSLContext の属性の代入メソッドの名前です。 TLS の交渉とホスト名の検証が両方成功してから返ります。

サーバが TLS の開始に同意した後、接続の設定 Net::IMAP::Config#open_timeout の秒数まで待ち、それを超えると Net::OpenTimeout が発生します。

互換性のため、starttls(options)(options はハッシュ)と starttls(certs, verify) の形も受け付けます。 starttls(options) はハッシュをキーワード引数に変換します。 starttls(certs, verify) の形は非推奨で、警告を出します。 certs と verify は Net::IMAP.new の certs と verify と同じように変換します。この警告は Warning[:deprecated] が真のとき(-W:deprecated を指定したときなど)だけ表示されます。

[PARAM] options:
OpenSSL::SSL::SSLContext#set_params に渡す SSL/TLS のパラメータ
[EXCEPTION] ArgumentError:
互換のための形の引数とキーワード引数を同時に渡した場合や、options のハッシュと verify を同時に渡した場合に発生します