ライブラリ
-
net
/ imap (31)
キーワード
-
add
_ response _ handler (2) - append (1)
- authenticate (1)
- check (1)
- close (1)
- copy (1)
- create (1)
- delete (1)
- disconnect (1)
- disconnected? (1)
- examine (1)
- greeting (1)
- idle (1)
-
idle
_ done (1) - login (1)
- logout (1)
- move (1)
- noop (1)
-
remove
_ response _ handler (1) - rename (1)
-
response
_ handlers (1) - responses (1)
- select (1)
- setquota (1)
- starttls (2)
- subscribe (1)
-
uid
_ copy (1) -
uid
_ move (1) - unsubscribe (1)
検索結果
先頭5件
-
Net
:: IMAP # add _ response _ handler(handler) -> () (18307.0) -
レスポンスハンドラを追加します。
...す。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取......ンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_response_handler do |resp|
p resp
end
@param handler 追加するハンドラ(Proc や Method オブジェクト)
@see Net::IMAP#remove_response_handler... -
Net
:: IMAP # add _ response _ handler(handler) {|resp| . . . } -> () (18307.0) -
レスポンスハンドラを追加します。
...す。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取......ンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_response_handler do |resp|
p resp
end
@param handler 追加するハンドラ(Proc や Method オブジェクト)
@see Net::IMAP#remove_response_handler... -
Net
:: IMAP # disconnect -> nil (18307.0) -
サーバとの接続を切断します。
...サーバとの接続を切断します。
@see Net::IMAP#disconnected?... -
Net
:: IMAP # disconnected? -> bool (18307.0) -
サーバとの接続が切断されていれば真を返します。
...サーバとの接続が切断されていれば真を返します。
@see Net::IMAP#disconnect... -
Net
:: IMAP # idle _ done -> () (18307.0) -
Net::IMAP#idle で 停止しているスレッドを1つ起こします。
...Net::IMAP#idle で
停止しているスレッドを1つ起こします。... -
Net
:: IMAP # remove _ response _ handler(handler) -> () (18307.0) -
レスポンスハンドラを削除します。
...レスポンスハンドラを削除します。
@param handler 削除するハンドラ
@see Net::IMAP#add_response_handler... -
Net
:: IMAP # response _ handlers -> Array (18307.0) -
設定されているレスポンスハンドラ全てを 配列で返します。
...設定されているレスポンスハンドラ全てを
配列で返します。
@see Net::IMAP#add_response_handler... -
Net
:: IMAP # responses -> { String => [object] } (18307.0) -
サーバから送られてきた untagged な応答の記録を返します。
サーバから送られてきた untagged な応答の記録を返します。
untagged な応答は種類ごとに記録されます。
応答の種類には "FLAGS", "OK", "UIDVALIDITY", "EXISTS" などがあり、
この文字列がハッシュテーブルのキーとなります。
そして各種類ごとに配列が用意され、untagged な応答を受信するたびに
その配列の末尾にその内容が記録されます。
例:
imap.select("inbox")
p imap.responses["EXISTS"].last
#=> 2
p imap.responses["UIDVALIDITY"... -
Net
:: IMAP # starttls(options) -> Net :: IMAP :: TaggedResponse (607.0) -
STARTTLS コマンドを送って TLS のセッションを開始します。
...換性のため、certs で証明書or証明書ディレクトリのファイル名(文字列)、
verify で検証するかどうか(Net::IMAP::VERIFY_PEER、
Net::IMAP::VERIFY_NONEに対応します)を
指定することができます。
@param options SSL/TLS のオプション(Hash オブジ... -
Net
:: IMAP # append(mailbox , message , flags = nil , date _ time = nil) -> Net :: IMAP :: TaggedResponse (307.0) -
APPEND コマンドを送ってメッセージをメールボックスの末尾に追加します。
...セージ文字列
@param flags メッセージに付加するフラグ(Symbol の配列)
@param date_time メッセージの時刻(Time オブジェクト)。省略時は現在時刻が使われる
@raise Net::IMAP::NoResponseError メールボックスが存在しない場合に発生します... -
Net
:: IMAP # authenticate(auth _ type , user , password) -> Net :: IMAP :: TaggedResponse (307.0) -
AUTHENTICATE コマンドを送り、クライアントを認証します。
...ticate('LOGIN', user, password)
auth_type としては以下がサポートされています。
* "LOGIN"
* "PLAIN"
* "CRAM-MD5"
* "DIGEST-MD5"
@param auth_type 認証方式を表す文字列
@param user ユーザ名文字列
@param password パスワード文字列
@see Net::IMAP#login... -
Net
:: IMAP # check -> Net :: IMAP :: TaggedResponse (307.0) -
CHECK コマンドを送り、現在処理しているメールボックスの チェックポイントを要求します。
CHECK コマンドを送り、現在処理しているメールボックスの
チェックポイントを要求します。
チェックポイントの要求とは、サーバ内部で保留状態になっている
操作を完了させることを意味します。例えばメモリ上にあるメールの
データをディスクに書き込むため、fsyncを呼んだりすることです。
実際に何が行なわれるかはサーバの実装によりますし、何も行なわれない
場合もあります。 -
Net
:: IMAP # close -> Net :: IMAP :: TaggedResponse (307.0) -
CLOSE コマンドを送り、処理中のメールボックスを閉じます。
CLOSE コマンドを送り、処理中のメールボックスを閉じます。
このコマンドによって、どのメールボックスも選択されていない
状態に移行します。
そして \Deleted フラグが付けられたメールがすべて削除されます。 -
Net
:: IMAP # copy(set , mailbox) -> Net :: IMAP :: TaggedResponse (307.0) -
COPY コマンドを送り、指定したメッセージを 指定したメールボックスの末尾に追加します。
...は
Net::IMAP#examine もしくは Net::IMAP#select で
指定したものを用います。
mailbox はコピー先のメールボックスです。
@param set コピーするメッセージの message sequence number
@param mailbox コピー先のメールボックス(文字列)
@see Net::IMAP#ui... -
Net
:: IMAP # create(mailbox) -> Net :: IMAP :: TaggedResponse (307.0) -
CREATE コマンドを送り、新しいメールボックスを作ります。
...CREATE コマンドを送り、新しいメールボックスを作ります。
@param mailbox 新しいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスが作れなかった場合に発生します... -
Net
:: IMAP # delete(mailbox) -> Net :: IMAP :: TaggedResponse (307.0) -
DELETE コマンドを送り、指定したメールボックスを削除します。
...を送り、指定したメールボックスを削除します。
@param mailbox 削除するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを削除できなかった場合
に発生します。指定した名前のメ... -
Net
:: IMAP # examine(mailbox) -> Net :: IMAP :: TaggedResponse (307.0) -
EXAMINE コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。
...ックスにします。
Net::IMAP#select と異なりセッション中はメールボックスが
読み取り専用となります。それ以外は select と同じです。
@param mailbox 処理対象としたいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError mailb... -
Net
:: IMAP # greeting -> Net :: IMAP :: UntaggedResponse (307.0) -
サーバから最初に送られてくるメッセージ(greeting message) を返します。
サーバから最初に送られてくるメッセージ(greeting message)
を返します。 -
Net
:: IMAP # idle {|resp| . . . } -> Net :: IMAP :: TaggedResponse (307.0) -
IDLE 命令を送り、メールボックスの非同期的変化を待ち受けます。
...ックは
Net::IMAP#add_response_handler によって
レスポンスハンドラとして用いられます。
また、このメソッドが終了する時点で
Net::IMAP#remove_response_handler で
ハンドラが削除されます。
レスポンスハンドラについては
Net::IMAP#add_res......ponse_handler を参照してください。
別のスレッドが Net::IMAP#idle_done を呼びだすまで
このメソッドを呼びだしたスレッドは停止します。
この命令は 2177 で定義されています。詳しくはそちらを
参照してください。... -
Net
:: IMAP # login(user , password) -> Net :: IMAP :: TaggedResponse (307.0) -
LOGIN コマンドを送り、平文でパスワードを送りクライアント ユーザを認証します。
...LOGIN コマンドを送り、平文でパスワードを送りクライアント
ユーザを認証します。
Net::IMAP#authenticate で "LOGIN" を使うのとは異なる
ことに注意してください。authenticate では AUTHENTICATE コマンドを
送ります。
認証成功時には......認証成功レスポンスを返り値として返します。
認証失敗時には例外が発生します。
@param user ユーザ名文字列
@param password パスワード文字列
@raise Net::IMAP::NoResponseError 認証に失敗した場合に発生します
@see Net::IMAP#authenticate... -
Net
:: IMAP # logout -> Net :: IMAP :: TaggedResponse (307.0) -
LOGOUT コマンドを送り、コネクションを切断することを サーバに伝えます。
LOGOUT コマンドを送り、コネクションを切断することを
サーバに伝えます。 -
Net
:: IMAP # move(set , mailbox) -> Net :: IMAP :: TaggedResponse (307.0) -
MOVEコマンドを送り、set で指定したメッセージを mailbox の 末尾に移動させます。
...ックスは
Net::IMAP#examine もしくは Net::IMAP#select で
指定したものを用います。
@param set 移動するメッセージの message sequence number(整数、整数の配列、整数の Range)
@param mailbox 移動先のメールボックス(文字列)
@see Net::IMAP#uid_move, 68... -
Net
:: IMAP # noop -> Net :: IMAP :: TaggedResponse (307.0) -
NOOP コマンドを送ります。
NOOP コマンドを送ります。
このコマンドは何もしません。 -
Net
:: IMAP # rename(mailbox , newname) -> Net :: IMAP :: TaggedResponse (307.0) -
RENAME コマンドを送り、指定したメールボックスをリネームします。
...ームします。
@param mailbox リネームするメールボックス(文字列)
@param newname リネーム後の名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
リネームできなかった場合に発生します。
指定し... -
Net
:: IMAP # select(mailbox) -> Net :: IMAP :: TaggedResponse (307.0) -
SELECT コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。
...態が「selected」になります。
このコマンドを実行した直後に Net::IMAP#responses["EXISTS"].last
を調べると、メールボックス内のメールの数がわかります。
また、Net::IMAP#responses["RECENT"].lastで、
最新のメールの数がわかります。
こ......わりうることに注意してください。
Net::IMAP#add_response_handler を使うとそのような更新情報を
即座に取得できます。
@param mailbox 処理対象としたいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError mailboxが存在しない等... -
Net
:: IMAP # setquota(mailbox , quota) -> Net :: IMAP :: TaggedResponse (307.0) -
SETQUOTA コマンドを送り、指定したメールボックスに quota を設定します。
...のコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
@param mailbox quota を設定するメールボックス名(文字列)
@param quota quotaの値(ストレージのサイズ、もしくは nil)
@raise Net::IMAP::NoResponseError 指... -
Net
:: IMAP # starttls(certs , verify) -> Net :: IMAP :: TaggedResponse (307.0) -
STARTTLS コマンドを送って TLS のセッションを開始します。
...換性のため、certs で証明書or証明書ディレクトリのファイル名(文字列)、
verify で検証するかどうか(Net::IMAP::VERIFY_PEER、
Net::IMAP::VERIFY_NONEに対応します)を
指定することができます。
@param options SSL/TLS のオプション(Hash オブジ... -
Net
:: IMAP # subscribe(mailbox) -> Net :: IMAP :: TaggedResponse (307.0) -
SUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合に 追加します。
..."subscribe" なメールボックスの集合に
追加します。
@param mailbox 追加するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
追加できなかった場合に発生します。
指定した名... -
Net
:: IMAP # uid _ copy(set , mailbox) -> Net :: IMAP :: TaggedResponse (307.0) -
UID COPY コマンドを送り、指定したメッセージを 指定したメールボックスの末尾に追加します。
...ルボックスは
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 (307.0) -
MOVEコマンドを送り、set でUIDで指定したメッセージを mailbox の 末尾に移動させます。
...ー元のメールボックスは
Net::IMAP#examine もしくは Net::IMAP#select で
指定したものを用います。
@param set 移動するメッセージのUID(整数、整数の配列、整数の Range)
@param mailbox 移動先のメールボックス(文字列)
@see Net::IMAP#move, 6851... -
Net
:: IMAP # unsubscribe(mailbox) -> Net :: IMAP :: TaggedResponse (307.0) -
UNSUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合から 削除します。
...be" なメールボックスの集合から
削除します。
@param mailbox 削除するするメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
削除できなかった場合に発生します。
指定した名...