クラス
キーワード
-
add
_ response _ handler (2) - append (1)
- authenticate (1)
- check (1)
- close (1)
- code (1)
- copy (1)
- create (1)
- data (4)
- delete (1)
- examine (1)
- greeting (1)
- idle (1)
- login (1)
- logout (1)
- move (1)
- name (3)
- noop (1)
-
raw
_ data (2) -
remove
_ response _ handler (1) - rename (1)
-
response
_ handlers (1) - responses (1)
- select (1)
- setquota (1)
- starttls (2)
- subscribe (1)
- tag (1)
- text (1)
-
uid
_ copy (1) -
uid
_ move (1) - unsubscribe (1)
検索結果
先頭5件
- Net
:: IMAP :: ResponseError # response -> Net :: IMAP :: TaggedResponse | Net :: IMAP :: UntaggedResponse - Net
:: IMAP # responses -> { String => [object] } - Net
:: IMAP :: TaggedResponse # data -> Net :: IMAP :: ResponseText - Net
:: IMAP # add _ response _ handler(handler) -> () - Net
:: IMAP # add _ response _ handler(handler) {|resp| . . . } -> ()
-
Net
:: IMAP :: ResponseError # response -> Net :: IMAP :: TaggedResponse | Net :: IMAP :: UntaggedResponse (74110.0) -
エラーとなったレスポンスを表すオブジェクトを返します。
エラーとなったレスポンスを表すオブジェクトを返します。 -
Net
:: IMAP # responses -> { String => [object] } (28507.0) -
サーバから送られてきた untagged な応答の記録を返します。
サーバから送られてきた untagged な応答の記録を返します。
untagged な応答は種類ごとに記録されます。
応答の種類には "FLAGS", "OK", "UIDVALIDITY", "EXISTS" などがあり、
この文字列がハッシュテーブルのキーとなります。
そして各種類ごとに配列が用意され、untagged な応答を受信するたびに
その配列の末尾にその内容が記録されます。
例:
imap.select("inbox")
p imap.responses["EXISTS"].last
#=> 2
p imap.responses["UIDVALIDITY"... -
Net
:: IMAP :: TaggedResponse # data -> Net :: IMAP :: ResponseText (28207.0) -
レスポンスを解析したオブジェクトを返します。
レスポンスを解析したオブジェクトを返します。
@see Net::IMAP::ResponseText -
Net
:: IMAP # add _ response _ handler(handler) -> () (27949.0) -
レスポンスハンドラを追加します。
レスポンスハンドラを追加します。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。
レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_respo... -
Net
:: IMAP # add _ response _ handler(handler) {|resp| . . . } -> () (27949.0) -
レスポンスハンドラを追加します。
レスポンスハンドラを追加します。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。
レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_respo... -
Net
:: IMAP # remove _ response _ handler(handler) -> () (27928.0) -
レスポンスハンドラを削除します。
レスポンスハンドラを削除します。
@param handler 削除するハンドラ
@see Net::IMAP#add_response_handler -
Net
:: IMAP # response _ handlers -> Array (27928.0) -
設定されているレスポンスハンドラ全てを 配列で返します。
設定されているレスポンスハンドラ全てを
配列で返します。
@see Net::IMAP#add_response_handler -
Net
:: IMAP :: ResponseCode # data -> object | nil (27907.0) -
レスポンスコードのデータを返します。
レスポンスコードのデータを返します。
レスポンスコードの種類によって返すオブジェクトは異なります。
ない場合は nil を返します。 -
Net
:: IMAP :: ResponseText # text -> String (27907.0) -
応答のテキストを文字列で返します。
応答のテキストを文字列で返します。 -
Net
:: IMAP :: TaggedResponse # raw _ data -> String (27907.0) -
レスポンス文字列を返します。
レスポンス文字列を返します。
@see Net::IMAP::TaggedResponse#data -
Net
:: IMAP :: TaggedResponse # tag -> String (27907.0) -
レスポンスに対応付けられたタグを返します。
レスポンスに対応付けられたタグを返します。 -
Net
:: IMAP :: UntaggedResponse # data -> object (27907.0) -
レスポンスを解析した結果のオブジェクトを返します。
レスポンスを解析した結果のオブジェクトを返します。
レスポンスによって異なるオブジェクトを返します。
Net::IMAP::MailboxList であったりフラグを表わす
シンボルの配列であったりします。 -
Net
:: IMAP :: UntaggedResponse # raw _ data -> String (27907.0) -
レスポンス文字列を返します。
レスポンス文字列を返します。
@see Net::IMAP::UntaggedResponse#data -
Net
:: IMAP # authenticate(auth _ type , user , password) -> Net :: IMAP :: TaggedResponse (19543.0) -
AUTHENTICATE コマンドを送り、クライアントを認証します。
AUTHENTICATE コマンドを送り、クライアントを認証します。
auth_type で利用する認証方式を文字列で指定します。
例:
imap.authenticate('LOGIN', user, password)
auth_type としては以下がサポートされています。
* "LOGIN"
* "PLAIN"
* "CRAM-MD5"
* "DIGEST-MD5"
@param auth_type 認証方式を表す文字列
@param user ユーザ名文字列
@param password パスワード文字列
@see Net::IMAP#login -
Net
:: IMAP # starttls(certs , verify) -> Net :: IMAP :: TaggedResponse (19507.0) -
STARTTLS コマンドを送って TLS のセッションを開始します。
STARTTLS コマンドを送って TLS のセッションを開始します。
options で openssl に渡すオプションを指定します。
OpenSSL::SSL::SSLContext#set_params の引数と同じ意味です。
互換性のため、certs で証明書or証明書ディレクトリのファイル名(文字列)、
verify で検証するかどうか(Net::IMAP::VERIFY_PEER、
Net::IMAP::VERIFY_NONEに対応します)を
指定することができます。
@param options SSL/TLS のオプション(Hash オブジェクト)
@param ce... -
Net
:: IMAP # starttls(options) -> Net :: IMAP :: TaggedResponse (19507.0) -
STARTTLS コマンドを送って TLS のセッションを開始します。
STARTTLS コマンドを送って TLS のセッションを開始します。
options で openssl に渡すオプションを指定します。
OpenSSL::SSL::SSLContext#set_params の引数と同じ意味です。
互換性のため、certs で証明書or証明書ディレクトリのファイル名(文字列)、
verify で検証するかどうか(Net::IMAP::VERIFY_PEER、
Net::IMAP::VERIFY_NONEに対応します)を
指定することができます。
@param options SSL/TLS のオプション(Hash オブジェクト)
@param ce... -
Net
:: IMAP # select(mailbox) -> Net :: IMAP :: TaggedResponse (19225.0) -
SELECT コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。
SELECT コマンドを送り、指定したメールボックスを処理対象の
メールボックスにします。
このコマンドが成功すると、クライアントの状態が「selected」になります。
このコマンドを実行した直後に Net::IMAP#responses["EXISTS"].last
を調べると、メールボックス内のメールの数がわかります。
また、Net::IMAP#responses["RECENT"].lastで、
最新のメールの数がわかります。
これらの値はセッション中に変わりうることに注意してください。
Net::IMAP#add_response_handler を使うとそのような更新情報を
即... -
Net
:: IMAP # create(mailbox) -> Net :: IMAP :: TaggedResponse (19207.0) -
CREATE コマンドを送り、新しいメールボックスを作ります。
CREATE コマンドを送り、新しいメールボックスを作ります。
@param mailbox 新しいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスが作れなかった場合に発生します -
Net
:: IMAP # delete(mailbox) -> Net :: IMAP :: TaggedResponse (19207.0) -
DELETE コマンドを送り、指定したメールボックスを削除します。
DELETE コマンドを送り、指定したメールボックスを削除します。
@param mailbox 削除するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを削除できなかった場合
に発生します。指定した名前のメールボックスが存在しない場合や、
ユーザにメールボックスを削除する権限がない場合に発生します。 -
Net
:: IMAP # greeting -> Net :: IMAP :: UntaggedResponse (19207.0) -
サーバから最初に送られてくるメッセージ(greeting message) を返します。
サーバから最初に送られてくるメッセージ(greeting message)
を返します。 -
Net
:: IMAP # logout -> Net :: IMAP :: TaggedResponse (19207.0) -
LOGOUT コマンドを送り、コネクションを切断することを サーバに伝えます。
LOGOUT コマンドを送り、コネクションを切断することを
サーバに伝えます。 -
Net
:: IMAP # setquota(mailbox , quota) -> Net :: IMAP :: TaggedResponse (19207.0) -
SETQUOTA コマンドを送り、指定したメールボックスに quota を設定します。
SETQUOTA コマンドを送り、指定したメールボックスに
quota を設定します。
quota が nil ならば、mailbox の quota を破棄します。
quota が整数なら STORAGE をその値に変更します。
詳しくは 2087 を見てください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
@param mailbox quota を設定するメールボックス名(文字列)
@param quota quotaの値(ストレージのサイズ、もしくは nil)
@raise Net::IMAP::NoRespo... -
Net
:: IMAP :: ContinuationRequest # data -> Net :: IMAP :: ResponseText (19207.0) -
レスポンスのデータを返します。
レスポンスのデータを返します。 -
Net
:: IMAP :: ResponseText # code -> Net :: IMAP :: ResponseCode | nil (19207.0) -
レスポンスコードを返します。
レスポンスコードを返します。
応答がレスポンスコードを含んでいない場合は nil を返します。
@see Net::IMAP::ResponseCode -
Net
:: IMAP :: ResponseCode # name -> String (18907.0) -
レスポンスコードを表す文字列を返します。 "ALERT"、"PERMANENTFLAGS"、"UIDVALIDITY" などを返します。
レスポンスコードを表す文字列を返します。
"ALERT"、"PERMANENTFLAGS"、"UIDVALIDITY" などを返します。 -
Net
:: IMAP :: TaggedResponse # name -> String (18907.0) -
レスポンスの名前(種類)を返します。
レスポンスの名前(種類)を返します。
例えば以下のような値を返します。これらの具体的な意味は
2060 を参考にしてください。
* "OK"
* "NO"
* "BAD" -
Net
:: IMAP :: UntaggedResponse # name -> String (18907.0) -
レスポンスの名前(種類)を返します。
レスポンスの名前(種類)を返します。
例えば以下のような値を返します。これらの具体的な意味は
2060 を参考にしてください。
* "OK"
* "NO"
* "BAD"
* "BYE"
* "PREAUTH"
* "CAPABILITY"
* "LIST"
* "FLAGS"
* etc -
Net
:: IMAP # idle {|resp| . . . } -> Net :: IMAP :: TaggedResponse (10261.0) -
IDLE 命令を送り、メールボックスの非同期的変化を待ち受けます。
IDLE 命令を送り、メールボックスの非同期的変化を待ち受けます。
このメソッドに渡したブロックは
Net::IMAP#add_response_handler によって
レスポンスハンドラとして用いられます。
また、このメソッドが終了する時点で
Net::IMAP#remove_response_handler で
ハンドラが削除されます。
レスポンスハンドラについては
Net::IMAP#add_response_handler を参照してください。
別のスレッドが Net::IMAP#idle_done を呼びだすまで
このメソッドを呼びだしたスレッドは停止します。
この命令は ... -
Net
:: IMAP # append(mailbox , message , flags = nil , date _ time = nil) -> Net :: IMAP :: TaggedResponse (10207.0) -
APPEND コマンドを送ってメッセージをメールボックスの末尾に追加します。
APPEND コマンドを送ってメッセージをメールボックスの末尾に追加します。
例:
imap.append("inbox", <<EOF.gsub(/\n/, "\r\n"), [:Seen], Time.now)
Subject: hello
From: someone@example.com
To: somebody@example.com
hello world
EOF
@param mailbox メッセージを追加するメールボックス名(文字列)
@param message メッセージ文字列
@param flags メッセージに付加するフラグ(S... -
Net
:: IMAP # check -> Net :: IMAP :: TaggedResponse (10207.0) -
CHECK コマンドを送り、現在処理しているメールボックスの チェックポイントを要求します。
CHECK コマンドを送り、現在処理しているメールボックスの
チェックポイントを要求します。
チェックポイントの要求とは、サーバ内部で保留状態になっている
操作を完了させることを意味します。例えばメモリ上にあるメールの
データをディスクに書き込むため、fsyncを呼んだりすることです。
実際に何が行なわれるかはサーバの実装によりますし、何も行なわれない
場合もあります。 -
Net
:: IMAP # close -> Net :: IMAP :: TaggedResponse (10207.0) -
CLOSE コマンドを送り、処理中のメールボックスを閉じます。
CLOSE コマンドを送り、処理中のメールボックスを閉じます。
このコマンドによって、どのメールボックスも選択されていない
状態に移行します。
そして \Deleted フラグが付けられたメールがすべて削除されます。 -
Net
:: IMAP # copy(set , mailbox) -> Net :: IMAP :: TaggedResponse (10207.0) -
COPY コマンドを送り、指定したメッセージを 指定したメールボックスの末尾に追加します。
COPY コマンドを送り、指定したメッセージを
指定したメールボックスの末尾に追加します。
set でコピーするメッセージを指定します。
message sequence number(整数)、
message sequence numberの配列、もしくは Range で
指定します。コピー元のメールボックスは
Net::IMAP#examine もしくは Net::IMAP#select で
指定したものを用います。
mailbox はコピー先のメールボックスです。
@param set コピーするメッセージの message sequence number
@param mailbo... -
Net
:: IMAP # examine(mailbox) -> Net :: IMAP :: TaggedResponse (10207.0) -
EXAMINE コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。
EXAMINE コマンドを送り、指定したメールボックスを処理対象の
メールボックスにします。
Net::IMAP#select と異なりセッション中はメールボックスが
読み取り専用となります。それ以外は select と同じです。
@param mailbox 処理対象としたいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError mailboxが存在しない等の理由でコマンドの実行に失敗
した場合に発生します。 -
Net
:: IMAP # login(user , password) -> Net :: IMAP :: TaggedResponse (10207.0) -
LOGIN コマンドを送り、平文でパスワードを送りクライアント ユーザを認証します。
LOGIN コマンドを送り、平文でパスワードを送りクライアント
ユーザを認証します。
Net::IMAP#authenticate で "LOGIN" を使うのとは異なる
ことに注意してください。authenticate では AUTHENTICATE コマンドを
送ります。
認証成功時には
認証成功レスポンスを返り値として返します。
認証失敗時には例外が発生します。
@param user ユーザ名文字列
@param password パスワード文字列
@raise Net::IMAP::NoResponseError 認証に失敗した場合に発生します
@see Net::IMAP#... -
Net
:: IMAP # move(set , mailbox) -> Net :: IMAP :: TaggedResponse (10207.0) -
MOVEコマンドを送り、set で指定したメッセージを mailbox の 末尾に移動させます。
MOVEコマンドを送り、set で指定したメッセージを mailbox の
末尾に移動させます。
set はmessage sequence number(整数)、
message sequence numberの配列、もしくは Range で
指定します。
コピー元のメールボックスは
Net::IMAP#examine もしくは Net::IMAP#select で
指定したものを用います。
@param set 移動するメッセージの message sequence number(整数、整数の配列、整数の Range)
@param mailbox 移動先のメールボックス(文字列)
... -
Net
:: IMAP # noop -> Net :: IMAP :: TaggedResponse (10207.0) -
NOOP コマンドを送ります。
NOOP コマンドを送ります。
このコマンドは何もしません。 -
Net
:: IMAP # rename(mailbox , newname) -> Net :: IMAP :: TaggedResponse (10207.0) -
RENAME コマンドを送り、指定したメールボックスをリネームします。
RENAME コマンドを送り、指定したメールボックスをリネームします。
@param mailbox リネームするメールボックス(文字列)
@param newname リネーム後の名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
リネームできなかった場合に発生します。
指定した名前のメールボックスが存在しない場合や、
リネーム後の名前を持つメールボックスが既に存在する
場合に発生します。 -
Net
:: IMAP # subscribe(mailbox) -> Net :: IMAP :: TaggedResponse (10207.0) -
SUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合に 追加します。
SUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合に
追加します。
@param mailbox 追加するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
追加できなかった場合に発生します。
指定した名前のメールボックスが存在しない場合などに
生じます。 -
Net
:: IMAP # uid _ copy(set , mailbox) -> Net :: IMAP :: TaggedResponse (10207.0) -
UID COPY コマンドを送り、指定したメッセージを 指定したメールボックスの末尾に追加します。
UID COPY コマンドを送り、指定したメッセージを
指定したメールボックスの末尾に追加します。
set でコピーするメッセージを指定します。
UID (整数)、
UID の配列、もしくは Range で
指定します。コピー元のメールボックスは
Net::IMAP#examine もしくは Net::IMAP#select で
指定したものを用います。
mailbox はコピー先のメールボックスです。
@param set コピーするメッセージの UID
@param mailbox コピー先のメールボックス(文字列)
@see Net::IMAP#copy -
Net
:: IMAP # uid _ move(set , mailbox) -> Net :: IMAP :: TaggedResponse (10207.0) -
MOVEコマンドを送り、set でUIDで指定したメッセージを mailbox の 末尾に移動させます。
MOVEコマンドを送り、set でUIDで指定したメッセージを mailbox の
末尾に移動させます。
set には UID、UID の配列、もしくは
Range オブジェクトを渡します。
コピー元のメールボックスは
Net::IMAP#examine もしくは Net::IMAP#select で
指定したものを用います。
@param set 移動するメッセージのUID(整数、整数の配列、整数の Range)
@param mailbox 移動先のメールボックス(文字列)
@see Net::IMAP#move, 6851 -
Net
:: IMAP # unsubscribe(mailbox) -> Net :: IMAP :: TaggedResponse (10207.0) -
UNSUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合から 削除します。
UNSUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合から
削除します。
@param mailbox 削除するするメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
削除できなかった場合に発生します。
指定した名前のメールボックスが active/subscribe でなかった
場合などに発生します。