Ruby 2.1.0 リファレンスマニュアル > ライブラリ一覧 > net/imapライブラリ > Net::IMAPクラス > examine

instance method Net::IMAP#examine

examine(mailbox) -> Net::IMAP::TaggedResponse[permalink][rdoc]

EXAMINE コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。

Net::IMAP#select と異なりセッション中はメールボックスが 読み取り専用となります。それ以外は select と同じです。

[PARAM] mailbox:

処理対象としたいメールボックスの名前(文字列)

[EXCEPTION] Net::IMAP::NoResponseError:

mailboxが存在しない等の理由でコマンドの実行に失敗 した場合に発生します。