るりまサーチ (Ruby 2.5.0)

最速Rubyリファレンスマニュアル検索!
152件ヒット [1-100件を表示] (0.016秒)

キーワード

検索結果

<< 1 2 > >>

Net::IMAP#add_response_handler(handler) -> () (10.0)

レスポンスハンドラを追加します。

レスポンスハンドラを追加します。

レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。

主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。

レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。

例:

imap.add_respo...

Net::IMAP#add_response_handler(handler) {|resp| ...} -> () (10.0)

レスポンスハンドラを追加します。

レスポンスハンドラを追加します。

レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。

主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。

レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。

例:

imap.add_respo...

Net::IMAP#append(mailbox, message, flags = nil, date_time = nil) -> Net::IMAP::TaggedResponse (10.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#authenticate(auth_type, user, password) -> Net::IMAP::TaggedResponse (10.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#capability -> [String] (10.0)

CAPABILITY コマンドを送ってサーバがサポートしている 機能(capabilities)のリストを文字列の配列として返します。

CAPABILITY コマンドを送ってサーバがサポートしている
機能(capabilities)のリストを文字列の配列として返します。

capability は IMAP に関連する RFC などで定義されています。

imap.capability
# => ["IMAP4REV1", "UNSELECT", "IDLE", "NAMESPACE", "QUOTA", ... ]

絞り込み条件を変える

Net::IMAP#check -> Net::IMAP::TaggedResponse (10.0)

CHECK コマンドを送り、現在処理しているメールボックスの チェックポイントを要求します。

CHECK コマンドを送り、現在処理しているメールボックスの
チェックポイントを要求します。

チェックポイントの要求とは、サーバ内部で保留状態になっている
操作を完了させることを意味します。例えばメモリ上にあるメールの
データをディスクに書き込むため、fsyncを呼んだりすることです。
実際に何が行なわれるかはサーバの実装によりますし、何も行なわれない
場合もあります。

Net::IMAP#client_thread -> Thread (10.0)

このメソッドは obsolete です。使わないでください。

このメソッドは obsolete です。使わないでください。

Net::IMAP#client_thread=(th) (10.0)

このメソッドは obsolete です。使わないでください。

このメソッドは obsolete です。使わないでください。

Net::IMAP#close -> Net::IMAP::TaggedResponse (10.0)

CLOSE コマンドを送り、処理中のメールボックスを閉じます。

CLOSE コマンドを送り、処理中のメールボックスを閉じます。

このコマンドによって、どのメールボックスも選択されていない
状態に移行します。
そして \Deleted フラグが付けられたメールがすべて削除されます。

Net::IMAP#copy(set, mailbox) -> Net::IMAP::TaggedResponse (10.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#create(mailbox) -> Net::IMAP::TaggedResponse (10.0)

CREATE コマンドを送り、新しいメールボックスを作ります。

CREATE コマンドを送り、新しいメールボックスを作ります。

@param mailbox 新しいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスが作れなかった場合に発生します

Net::IMAP#delete(mailbox) -> Net::IMAP::TaggedResponse (10.0)

DELETE コマンドを送り、指定したメールボックスを削除します。

DELETE コマンドを送り、指定したメールボックスを削除します。

@param mailbox 削除するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを削除できなかった場合
に発生します。指定した名前のメールボックスが存在しない場合や、
ユーザにメールボックスを削除する権限がない場合に発生します。

Net::IMAP#disconnect -> nil (10.0)

サーバとの接続を切断します。

サーバとの接続を切断します。

@see Net::IMAP#disconnected?

Net::IMAP#disconnected? -> bool (10.0)

サーバとの接続が切断されていれば真を返します。

サーバとの接続が切断されていれば真を返します。

@see Net::IMAP#disconnect

Net::IMAP#examine(mailbox) -> Net::IMAP::TaggedResponse (10.0)

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

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

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

@param mailbox 処理対象としたいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError mailboxが存在しない等の理由でコマンドの実行に失敗
した場合に発生します。

絞り込み条件を変える

Net::IMAP#expunge -> [Integer] | nil (10.0)

EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを すべて処理中のメールボックスから削除します。

EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを
すべて処理中のメールボックスから削除します。

削除したメッセージの message sequence number を配列で返します。

@raise Net::IMAP::NoResponseError メールボックスが read-only である場合に発生します

Net::IMAP#fetch(set, attr) -> [Net::IMAP::FetchData] (10.0)

FETCH コマンドを送り、メールボックス内のメッセージに 関するデータを取得します。

FETCH コマンドを送り、メールボックス内のメッセージに
関するデータを取得します。

Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを対象とします。

set で対象とするメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。
attr には取得するアトリビュートを文字列の配列で渡してください。
指定可能なアトリビュートについては Net::IMAP::FetchData#attr
を見てください。

例:

p imap....

Net::IMAP#getacl(mailbox) -> [Net::IMAP::MailboxACLItem] (10.0)

GETACL コマンドを送り、メールボックスの ACL(Access Control List) を取得します。

GETACL コマンドを送り、メールボックスの
ACL(Access Control List) を取得します。

Net::IMAP#getacl で指定したメールボックスに
対し何らかの権限を持つ各ユーザに対して
Net::IMAP::MailboxACLItem オブジェクトが
作られ、その配列が返されます。

GETACL コマンドは 2086 で定義されています。
詳しくはそちらを参照してください。

@param mailbox メールボックス名(文字列)
@see Net::IMAP::MailboxACLItem

Net::IMAP#getquota(mailbox) -> [Net::IMAP::MailboxQuota] (10.0)

GETQUOTA コマンドを送って 指定したメールボックスの quota の情報を返します。

GETQUOTA コマンドを送って
指定したメールボックスの quota の情報を返します。

quota の情報は Net::IMAP::MailboxQuota オブジェクトの配列で
得られます。

詳しくは 2087 を見てください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。

@param mailbox quota 情報を得たいメールボックス名
@raise Net::IMAP::NoResponseError 指定したメールボックスが quota root でない場合に発生します

Net::IMAP#getquotaroot(mailbox) -> [Net::IMAP::MailboxQuotaRoot | Net::IMAP::MailboxQuota] (10.0)

GETQUOTAROOT コマンドを送って 指定したメールボックスの quota root の一覧と、 関連する quota の情報を返します。

GETQUOTAROOT コマンドを送って
指定したメールボックスの quota root の一覧と、
関連する quota の情報を返します。

quota root の情報は Net::IMAP::MailboxQuotaRoot のオブジェクトで、
返り値の配列の中に唯一含まれています。
quota の情報はメールボックスに関連付けられた quota root ごとに
Net::IMAP::MailboxQuota オブジェクトで得られます。

詳しくは 2087 を見てください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できま...

絞り込み条件を変える

Net::IMAP#greeting -> Net::IMAP::UntaggedResponse (10.0)

サーバから最初に送られてくるメッセージ(greeting message) を返します。

サーバから最初に送られてくるメッセージ(greeting message)
を返します。

Net::IMAP#idle {|resp| ...} -> Net::IMAP::TaggedResponse (10.0)

IDLE 命令を送り、メールボックスの非同期的変化を待ち受けます。

IDLE 命令を送り、メールボックスの非同期的変化を待ち受けます。

このメソッドに渡したブロックは
Net::IMAP#add_response_handler によって
レスポンスハンドラとして用いられます。
また、このメソッドが終了する時点で
Net::IMAP#remove_response_handler で
ハンドラが削除されます。

レスポンスハンドラについては
Net::IMAP#add_response_handler を参照してください。

別のスレッドが Net::IMAP#idle_done を呼びだすまで
このメソッドを呼びだしたスレッドは停止します。

この命令は ...

Net::IMAP#idle_done -> () (10.0)

Net::IMAP#idle で 停止しているスレッドを1つ起こします。

Net::IMAP#idle で
停止しているスレッドを1つ起こします。

Net::IMAP#list(refname, mailbox) -> [Net::IMAP::MailboxList] | nil (10.0)

LIST コマンドを送り、クライアントから利用可能なメールボックス名の集合から 引数にマッチするものすべてを返します。

LIST コマンドを送り、クライアントから利用可能なメールボックス名の集合から
引数にマッチするものすべてを返します。

詳しくは 2060 の 6.3.8 を参照してください。

返り値は Net::IMAP::MailboxList の配列で返します。
返り値が空集合である場合は空の配列でなく nil を返します。

@param refname 参照名(文字列)
@param mailbox 調べるメールボックスの名前(文字列)。ワイルドカードを含んでいてもかまいません。

例:
imap.create("foo/bar")
imap.create("foo/baz")
...

Net::IMAP#login(user, password) -> Net::IMAP::TaggedResponse (10.0)

LOGIN コマンドを送り、平文でパスワードを送りクライアント ユーザを認証します。

LOGIN コマンドを送り、平文でパスワードを送りクライアント
ユーザを認証します。

Net::IMAP#authenticate で "LOGIN" を使うのとは異なる
ことに注意してください。authenticate では AUTHENTICATE コマンドを
送ります。

認証成功時には
認証成功レスポンスを返り値として返します。

認証失敗時には例外が発生します。

@param user ユーザ名文字列
@param password パスワード文字列
@raise Net::IMAP::NoResponseError 認証に失敗した場合に発生します
@see Net::IMAP#...

絞り込み条件を変える

Net::IMAP#logout -> Net::IMAP::TaggedResponse (10.0)

LOGOUT コマンドを送り、コネクションを切断することを サーバに伝えます。

LOGOUT コマンドを送り、コネクションを切断することを
サーバに伝えます。

Net::IMAP#lsub(refname, mailbox) -> [Net::IMAP::MailboxList] (10.0)

LIST コマンドを送り、active/subscribed なメールボックス名の集合から 引数にマッチするものすべてを返します。

LIST コマンドを送り、active/subscribed なメールボックス名の集合から
引数にマッチするものすべてを返します。

詳しくは 2060 の 6.3.8 を参照してください。

返り値は Net::IMAP::MailboxList の配列で返します。
返り値が空集合である場合は空の配列でなく nil を返します。

@param refname 参照名(文字列)
@param mailbox 調べるメールボックスの名前(文字列)。ワイルドカードを含んでいてもかまいません。

Net::IMAP#move(set, mailbox) -> Net::IMAP::TaggedResponse (10.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 (10.0)

NOOP コマンドを送ります。

NOOP コマンドを送ります。

このコマンドは何もしません。

Net::IMAP#remove_response_handler(handler) -> () (10.0)

レスポンスハンドラを削除します。

レスポンスハンドラを削除します。

@param handler 削除するハンドラ
@see Net::IMAP#add_response_handler

絞り込み条件を変える

Net::IMAP#rename(mailbox, newname) -> Net::IMAP::TaggedResponse (10.0)

RENAME コマンドを送り、指定したメールボックスをリネームします。

RENAME コマンドを送り、指定したメールボックスをリネームします。

@param mailbox リネームするメールボックス(文字列)
@param newname リネーム後の名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
リネームできなかった場合に発生します。
指定した名前のメールボックスが存在しない場合や、
リネーム後の名前を持つメールボックスが既に存在する
場合に発生します。

Net::IMAP#response_handlers -> Array (10.0)

設定されているレスポンスハンドラ全てを 配列で返します。

設定されているレスポンスハンドラ全てを
配列で返します。

@see Net::IMAP#add_response_handler

Net::IMAP#responses -> { String => [object] } (10.0)

サーバから送られてきた untagged な応答の記録を返します。

サーバから送られてきた untagged な応答の記録を返します。

untagged な応答は種類ごとに記録されます。
応答の種類には "FLAGS", "OK", "UIDVALIDITY", "EXISTS" などがあり、
この文字列がハッシュテーブルのキーとなります。
そして各種類ごとに配列が用意され、untagged な応答を受信するたびに
その配列の末尾にその内容が記録されます。


例:
imap.select("inbox")
p imap.responses["EXISTS"].last
#=> 2
p imap.responses["UIDVALIDITY"...

Net::IMAP#search(keys, charset = nil) -> [Integer] (10.0)

SEARCH コマンドを送り、条件に合うメッセージの message sequence number を配列で返します。

SEARCH コマンドを送り、条件に合うメッセージの message sequence number
を配列で返します。

Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを検索対象とします。

検索の条件は key に文字列の1次元配列もしくは文字列で渡します。

検索条件は "SUBJECT", "FROM" などを用いることができます。
詳しくは 2060 の 6.4.4 を見てください。

例:
p imap.search(["SUBJECT", "hello"])
#=> [1, 6, 7, 8]
p imap.s...

Net::IMAP#select(mailbox) -> Net::IMAP::TaggedResponse (10.0)

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

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

このコマンドが成功すると、クライアントの状態が「selected」になります。

このコマンドを実行した直後に Net::IMAP#responses["EXISTS"].last
を調べると、メールボックス内のメールの数がわかります。
また、Net::IMAP#responses["RECENT"].lastで、
最新のメールの数がわかります。
これらの値はセッション中に変わりうることに注意してください。
Net::IMAP#add_response_handler を使うとそのような更新情報を
即...

絞り込み条件を変える

Net::IMAP#setacl(mailbox, user, rights) (10.0)

SETACL コマンドを送り、指定したメールボックスに 指定したユーザに関する権限を設定します。

SETACL コマンドを送り、指定したメールボックスに
指定したユーザに関する権限を設定します。

rights には設定する権限を表す文字列を指定します。
どのような文字列を指定すべきかは 2086 を参照してください。
rights に nil を渡すと、空文字列を指定したのと同様、つまり
すべての権限を削除します。

@param mailbox 権限を設定するメールボックスの名前(文字列)
@param user 権限を設定するユーザの名前(文字列)
@param rights 権限を表す文字列

Net::IMAP#setquota(mailbox, quota) -> Net::IMAP::TaggedResponse (10.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#sort(sort_keys, search_keys, charset) -> [Integer] (10.0)

SORT コマンド送り、メールボックス内の メッセージをソートした結果を返します。

SORT コマンド送り、メールボックス内の
メッセージをソートした結果を返します。

SORT コマンドは 5256 で定義されています。
詳しくはそちらを参照してください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。

sort_keys にはソート順を決めるキーを文字列の配列で指定します。
"ARRIVAL", "CC", "FROM", "TO", "SUBJECT" などが指定できます。
詳しくは 5265 の BASE.6.4.SORT の所を見てください。

search_key には検索条件を渡します。Net::...

Net::IMAP#starttls(certs, verify) -> Net::IMAP::TaggedResponse (10.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 (10.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#status(mailbox, attr) -> {String => Integer} (10.0)

STATUS コマンドを送り、mailbox のステータスを得ます。

STATUS コマンドを送り、mailbox のステータスを得ます。

問い合わせたいステータスは attr に文字列の配列で渡します。

返り値は アトリビュート文字列をキーとするハッシュです。

詳しくは 2060 の 6.3.10 を参考にしてください。

例:
p imap.status("inbox", ["MESSAGES", "RECENT"])
#=> {"RECENT"=>0, "MESSAGES"=>44}

@param mailbox 問い合わせ対象のメールボックス(文字列)
@param attr 問合せたいアトリビュート名(文字列)の配列
@raise Ne...

Net::IMAP#store(set, attr, flags) -> [Net::IMAP::FetchData] | nil (10.0)

STORE コマンドを送り、メールボックス内のメッセージを 更新します。

STORE コマンドを送り、メールボックス内のメッセージを
更新します。

set で更新するメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。

Net::IMAP#select で指定したメールボックスを対象とします。

attr で何をどのように変化させるかを指定します。
以下を指定することができます。
* "FLAGS"
* "+FLAGS"
* "-FLAGS"
それぞれメッセージのフラグの置き換え、追加、削除を意味します。
詳しくは 2060 の 6.4.6 を参考に...

Net::IMAP#subscribe(mailbox) -> Net::IMAP::TaggedResponse (10.0)

SUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合に 追加します。

SUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合に
追加します。

@param mailbox 追加するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
追加できなかった場合に発生します。
指定した名前のメールボックスが存在しない場合などに
生じます。

Net::IMAP#thread(algorithm, search_keys, charset) -> [Net::IMAP::ThreadMember] (10.0)

THREADコマンドを送り、メールボックスを検索した結果を スレッド形式の木構造で返します。

THREADコマンドを送り、メールボックスを検索した結果を
スレッド形式の木構造で返します。

THREAD コマンドは 5256 で定義されています。
詳しくはそちらを参照してください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。

algorithm は木構造を決定するためのアルゴリズムを指定します。
以下の2つが利用可能です。
* "ORDEREDSUBJECT" subjectを使って平坦に区切るだけ
* "REFERENCES" どのメッセージに返事をしているかを見て木構造を作る
詳しくは 5256 を見てく...

Net::IMAP#uid_copy(set, mailbox) -> Net::IMAP::TaggedResponse (10.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_fetch(set, attr) -> [Net::IMAP::FetchData] (10.0)

UID FETCH コマンドを送り、メールボックス内のメッセージに 関するデータを取得します。

UID FETCH コマンドを送り、メールボックス内のメッセージに
関するデータを取得します。

Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを対象とします。

set で対象とするメッセージを指定します。
これには UID、UID の配列、もしくは
Range オブジェクトを渡します。
attr には取得するアトリビュートを文字列の配列で渡してください。
指定可能なアトリビュートについては Net::IMAP::FetchData#attr
を見てください。

@param set 処理対象のメッセージの UID
@param...

Net::IMAP#uid_move(set, mailbox) -> Net::IMAP::TaggedResponse (10.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#uid_search(keys, charset = nil) -> [Integer] (10.0)

UID SEARCH コマンドを送り、条件に合うメッセージの UID を配列で返します。

UID SEARCH コマンドを送り、条件に合うメッセージの UID
を配列で返します。

Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを検索対象とします。

検索の条件は key に文字列の1次元配列もしくは文字列で渡します。

検索条件は "SUBJECT", "FROM" などを用いることができます。
詳しくは 2060 の 6.4.4 を見てください。

例:
p imap.uid_search(["SUBJECT", "hello"])
#=> [1, 6, 7, 8]
p imap.uid_search([...

Net::IMAP#uid_sort(sort_keys, search_keys, charset) -> [Integer] (10.0)

SORT コマンド送り、メールボックス内の メッセージをソートした結果を返します。

SORT コマンド送り、メールボックス内の
メッセージをソートした結果を返します。

SORT コマンドは 5256 で定義されています。
詳しくはそちらを参照してください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。

sort_keys にはソート順を決めるキーを文字列の配列で指定します。
"ARRIVAL", "CC", "FROM", "TO", "SUBJECT" などが指定できます。
詳しくは 5265 の BASE.6.4.SORT の所を見てください。

search_key には検索条件を渡します。Net::...

Net::IMAP#uid_store(set, attr, flags) -> [Net::IMAP::FetchData] | nil (10.0)

UID STORE コマンドを送り、メールボックス内のメッセージを 更新します。

UID STORE コマンドを送り、メールボックス内のメッセージを
更新します。

set で更新するメッセージを指定します。
これには UID、UID の配列、もしくは
Range オブジェクトを渡します。

Net::IMAP#select で指定したメールボックスを対象とします。

attr で何をどのように変化させるかを指定します。
以下を指定することができます。
* "FLAGS"
* "+FLAGS"
* "-FLAGS"
それぞれメッセージのフラグの置き換え、追加、削除を意味します。
詳しくは 2060 の 6.4.6 を参考にしてください。

返り値は更新された内...

絞り込み条件を変える

Net::IMAP#uid_thread(algorithm, search_keys, charset) -> [Net::IMAP::ThreadMember] (10.0)

THREADコマンドを送り、メールボックスを検索した結果を スレッド形式の木構造で返します。

THREADコマンドを送り、メールボックスを検索した結果を
スレッド形式の木構造で返します。

ほぼ Net::IMAP#thread と同じですが、返ってくるオブジェクトの
Net::IMAP::ThreadMember#seqno の内容が message sequence number
ではなく UID となります。

@param algorithm スレッド構造構築アルゴリズム名(文字列)
@param search_key 検索条件(文字列配列)
@param charset 検索条件の解釈に用いるCHARSET名(文字列)
@see Net::IMAP::ThreadMember...

Net::IMAP#unsubscribe(mailbox) -> Net::IMAP::TaggedResponse (10.0)

UNSUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合から 削除します。

UNSUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合から
削除します。

@param mailbox 削除するするメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
削除できなかった場合に発生します。
指定した名前のメールボックスが active/subscribe でなかった
場合などに発生します。

Net::IMAP#xlist(refname, mailbox) -> [Net::IMAP::MailboxList] (10.0)

XLISTコマンドを送り、クライアントから利用可能なメールボックス名の集合から 引数にマッチするものすべてを返します。

XLISTコマンドを送り、クライアントから利用可能なメールボックス名の集合から
引数にマッチするものすべてを返します。

Net::IMAP#list とほぼ同様ですが、
「:Sent」などの拡張されたフラグを含むことが異なります。

詳しくは
http://code.google.com/apis/gmail/imap/
を参照してください。

@param refname 参照名(文字列)
@param mailbox 調べるメールボックスの名前(文字列)。ワイルドカードを含んでいてもかまいません。

例:
imap.create("foo/bar")
imap.create("...

Net::IMAP::Address#host -> String | nil (10.0)

メールアドレスのホスト名を返します。

メールアドレスのホスト名を返します。

nil は 822 のグループ文法に対応します。
これについては Net::IMAP::Address#mailbox も参照してください。
そうでない場合は 822 のドメイン名を表します。

通常は、メールアドレスの「@」の後ろのドメイン名を返します。

Net::IMAP::Address#mailbox -> String | nil (10.0)

メールアドレスのメールボックス名を返します。

メールアドレスのメールボックス名を返します。

これが nil ならばそれは 822 group の終わりを意味します。
これが nil でなく、Net::IMAP::Address#mailbox が nil ならば、
822 のグループ名を表します。
どれでもなければ、822 の local-part を表します。

通常は、メールアドレスの「@」の手前を返します。

絞り込み条件を変える

Net::IMAP::Address#name -> String | nil (10.0)

メールアドレスの 822 の個人名(personal name)を返します。

メールアドレスの 822 の個人名(personal name)を返します。

個人名が存在しない場合は nil を返します。

通常は nil を返します。

Net::IMAP::Address#route -> String | nil (10.0)

メールアドレスの SMTP at-domain-list を返します。

メールアドレスの SMTP at-domain-list を返します。

存在しない場合は nil を返します。

通常は nil を返します。

Net::IMAP::BodyTypeBasic#content_id -> String | nil (10.0)

Content-ID の値を文字列で返します。

Content-ID の値を文字列で返します。

@see 2045

Net::IMAP::BodyTypeBasic#description -> String | nil (10.0)

Content-Description の値を文字列で返します。

Content-Description の値を文字列で返します。

@see 2045

Net::IMAP::BodyTypeBasic#disposition -> Net::IMAP::ContentDisposition | nil (10.0)

Content-Dispotition の値を返します。

Content-Dispotition の値を返します。

Net::IMAP::ContentDisposition オブジェクトを返します。

@see 1806, 2183

絞り込み条件を変える

Net::IMAP::BodyTypeBasic#encoding -> String (10.0)

Content-Transfer-Encoding の値を文字列で返します。

Content-Transfer-Encoding の値を文字列で返します。

@see 2045

Net::IMAP::BodyTypeBasic#extension -> Array | nil (10.0)

メッセージの拡張データを返します。

メッセージの拡張データを返します。

Net::IMAP::BodyTypeBasic#language -> String | [String] | nil (10.0)

1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。

1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。

Net::IMAP::BodyTypeBasic#md5 -> String | nil (10.0)

ボディの MD5 値を文字列で返します。

ボディの MD5 値を文字列で返します。

Net::IMAP::BodyTypeBasic#media_subtype -> String (10.0)

MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。

MIME のメディアタイプのサブタイプを返します。

media_subtype は obsolete です。

@see Net::IMAP::BodyTypeBasic#media_type

絞り込み条件を変える

Net::IMAP::BodyTypeBasic#media_type -> String (10.0)

MIME のメディアタイプを返します。

MIME のメディアタイプを返します。

@see Net::IMAP::BodyTypeBasic#subtype

Net::IMAP::BodyTypeBasic#multipart? -> bool (10.0)

マルチパートかどうかを返します。 false を返します。

マルチパートかどうかを返します。
false を返します。

Net::IMAP::BodyTypeBasic#param -> { String => String } | nil (10.0)

MIME のボディパラメータをハッシュテーブルで返します。

MIME のボディパラメータをハッシュテーブルで返します。

ハッシュテーブルのキーがパラメータ名となります。

@see 2045

Net::IMAP::BodyTypeBasic#size -> Integer (10.0)

ボディのサイズのオクテット数を返します。

ボディのサイズのオクテット数を返します。

Net::IMAP::BodyTypeBasic#subtype -> String (10.0)

MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。

MIME のメディアタイプのサブタイプを返します。

media_subtype は obsolete です。

@see Net::IMAP::BodyTypeBasic#media_type

絞り込み条件を変える

Net::IMAP::BodyTypeMessage#body -> Net::IMAP::BodyTypeBasic | Net::IMAP::BodyTypeMessage | Net::IMAP::BodyTypeText | Net::IMAP::BodyTypeMultipart (10.0)

ボディを返します。

ボディを返します。

Net::IMAP::BodyTypeMessage#content_id -> String | nil (10.0)

Content-ID の値を文字列で返します。

Content-ID の値を文字列で返します。

@see 2045

Net::IMAP::BodyTypeMessage#description -> String | nil (10.0)

Content-Description の値を文字列で返します。

Content-Description の値を文字列で返します。

@see 2045

Net::IMAP::BodyTypeMessage#disposition -> Net::IMAP::ContentDisposition | nil (10.0)

Content-Dispotition の値を返します。

Content-Dispotition の値を返します。

Net::IMAP::ContentDisposition オブジェクトを返します。

@see 1806, 2183

Net::IMAP::BodyTypeMessage#encoding -> String (10.0)

Content-Transfer-Encoding の値を文字列で返します。

Content-Transfer-Encoding の値を文字列で返します。

@see 2045

絞り込み条件を変える

Net::IMAP::BodyTypeMessage#envelope -> Net::IMAP::Envelpe | nil (10.0)

メッセージのエンベロープを返します。

メッセージのエンベロープを返します。

Net::IMAP::BodyTypeMessage#extension -> Array | nil (10.0)

メッセージの拡張データを返します。

メッセージの拡張データを返します。

Net::IMAP::BodyTypeMessage#language -> String | [String] | nil (10.0)

1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。

1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。

Net::IMAP::BodyTypeMessage#lines -> Integer (10.0)

ボディのテキストの行数を返します。

ボディのテキストの行数を返します。

Net::IMAP::BodyTypeMessage#md5 -> String | nil (10.0)

ボディの MD5 値を文字列で返します。

ボディの MD5 値を文字列で返します。

絞り込み条件を変える

Net::IMAP::BodyTypeMessage#media_subtype -> String (10.0)

MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。

MIME のメディアタイプのサブタイプを返します。

media_subtype は obsolete です。

@see Net::IMAP::BodyTypeMessage#media_type

Net::IMAP::BodyTypeMessage#media_type -> String (10.0)

MIME のメディアタイプを返します。

MIME のメディアタイプを返します。

これは "MESSAGE" を返します。

@see Net::IMAP::BodyTypeMessage#subtype

Net::IMAP::BodyTypeMessage#multipart? -> bool (10.0)

マルチパートかどうかを返します。 false を返します。

マルチパートかどうかを返します。
false を返します。

Net::IMAP::BodyTypeMessage#param -> { String => String } | nil (10.0)

MIME のボディパラメータをハッシュテーブルで返します。

MIME のボディパラメータをハッシュテーブルで返します。

ハッシュテーブルのキーがパラメータ名となります。

@see 2045

Net::IMAP::BodyTypeMessage#size -> Integer (10.0)

ボディのサイズのオクテット数を返します。

ボディのサイズのオクテット数を返します。

絞り込み条件を変える

Net::IMAP::BodyTypeMessage#subtype -> String (10.0)

MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。

MIME のメディアタイプのサブタイプを返します。

media_subtype は obsolete です。

@see Net::IMAP::BodyTypeMessage#media_type

Net::IMAP::BodyTypeMultipart#disposition -> Net::IMAP::ContentDisposition | nil (10.0)

Content-Dispotition の値を返します。

Content-Dispotition の値を返します。

Net::IMAP::ContentDisposition オブジェクトを返します。

@see 1806, 2183

Net::IMAP::BodyTypeMultipart#extension -> Array | nil (10.0)

メッセージの拡張データを返します。

メッセージの拡張データを返します。

Net::IMAP::BodyTypeMultipart#language -> String | [String] | nil (10.0)

1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。

1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。

Net::IMAP::BodyTypeMultipart#media_subtype -> String (10.0)

MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。

MIME のメディアタイプのサブタイプを返します。

media_subtype は obsolete です。

@see 2045, Net::IMAP::BodyTypeText#media_type

絞り込み条件を変える

Net::IMAP::BodyTypeMultipart#media_type -> String (10.0)

MIME のメディアタイプを返します。

MIME のメディアタイプを返します。

"MULTIPART" を返します。

@see Net::IMAP::BodyTypeMultipart#subtype

Net::IMAP::BodyTypeMultipart#multipart? -> bool (10.0)

マルチパートかどうかを返します。 true を返します。

マルチパートかどうかを返します。
true を返します。

Net::IMAP::BodyTypeMultipart#param -> { String => String } (10.0)

MIME のボディパラメータをハッシュテーブルで返します。

MIME のボディパラメータをハッシュテーブルで返します。

ハッシュテーブルのキーがパラメータ名となります。

@see 2045

Net::IMAP::BodyTypeMultipart#parts -> [Net::IMAP::BodyTypeBasic | Net::IMAP::BodyTypeText | Net::IMAP::BodyTypeMessage | Net::IMAP::BodyTypeMultipart] (10.0)

マルチパートの各部分を返します。

マルチパートの各部分を返します。

Net::IMAP::BodyTypeMultipart#subtype -> String (10.0)

MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。

MIME のメディアタイプのサブタイプを返します。

media_subtype は obsolete です。

@see 2045, Net::IMAP::BodyTypeText#media_type

絞り込み条件を変える

Net::IMAP::BodyTypeText#content_id -> String | nil (10.0)

Content-ID の値を文字列で返します。

Content-ID の値を文字列で返します。

@see 2045

Net::IMAP::BodyTypeText#description -> String | nil (10.0)

Content-Description の値を文字列で返します。

Content-Description の値を文字列で返します。

@see 2045

Net::IMAP::BodyTypeText#disposition -> Net::IMAP::ContentDisposition | nil (10.0)

Content-Dispotition の値を返します。

Content-Dispotition の値を返します。

Net::IMAP::ContentDisposition オブジェクトを返します。

@see 1806, 2183

Net::IMAP::BodyTypeText#encoding -> String (10.0)

Content-Transfer-Encoding の値を文字列で返します。

Content-Transfer-Encoding の値を文字列で返します。

@see 2045

Net::IMAP::BodyTypeText#extension -> Array | nil (10.0)

メッセージの拡張データを返します。

メッセージの拡張データを返します。

絞り込み条件を変える

<< 1 2 > >>