種類:インスタンスメソッド > バージョン:2.2.0 > クラス:Net::IMAP

51件ヒット [1-51件を表示] （0.065秒）

トップページ >

:インスタンスメソッド

:2.2.0

> クラス:Net::IMAP

ライブラリ

net/imap (51)

キーワード

add_response_handler (2)
append (1)
authenticate (1)
capability (1)
check (1)
client_thread (1)
client_thread= (1)
close (1)
copy (1)
create (1)
delete (1)
disconnect (1)
disconnected? (1)
examine (1)
expunge (1)
fetch (1)
getacl (1)
getquota (1)
getquotaroot (1)
greeting (1)
idle (1)
idle_done (1)
list (1)
login (1)
logout (1)
lsub (1)
noop (1)
remove_response_handler (1)
rename (1)
response_handlers (1)
responses (1)
search (1)
select (1)
setacl (1)
setquota (1)
sort (1)
starttls (2)
status (1)
store (1)
subscribe (1)
thread (1)
uid_copy (1)
uid_fetch (1)
uid_search (1)
uid_sort (1)
uid_store (1)
uid_thread (1)
unsubscribe (1)
xlist (1)

検索結果

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

2.2.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| ...} -> () (7.0)

2.2.0

インスタンスメソッド

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

Net::IMAP#append(mailbox, message, flags = nil, date_time = nil) -> Net::IMAP::TaggedResponse (7.0)

2.2.0

インスタンスメソッド

APPEND コマンドを送ってメッセージをメールボックスの末尾に追加します。

...セージ文字列
@param flags メッセージに付加するフラグ(Symbol の配列)
@param date_time メッセージの時刻(Time オブジェクト)。省略時は現在時刻が使われる
@raise Net::IMAP::NoResponseError メールボックスが存在しない場合に発生します...

Net::IMAP#authenticate(auth_type, user, password) -> Net::IMAP::TaggedResponse (7.0)

2.2.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#capability -> [String] (7.0)

2.2.0

インスタンスメソッド

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

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

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

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

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

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

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

Net::IMAP#copy(set, mailbox) -> Net::IMAP::TaggedResponse (7.0)

2.2.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 (7.0)

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

...を送り、指定したメールボックスを削除します。

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

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

2.2.0

インスタンスメソッド

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

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

@see Net::IMAP#disconnected?...

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

2.2.0

インスタンスメソッド

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

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

@see Net::IMAP#disconnect...

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

2.2.0

インスタンスメソッド

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

...ックスにします。

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

@param mailbox 処理対象としたいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError mailb...

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

...ラグをセットしたメッセージを
すべて処理中のメールボックスから削除します。

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

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

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

2.2.0

インスタンスメソッド

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

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

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

set で対象とするメッセージを指定します。
これには...

...可能なアトリビュートについては Net::IMAP::FetchData#attr
を見てください。

例:

p imap.fetch(6..8, "UID")
#=> [#<Net::IMAP::FetchData seqno=6, attr={"UID"=>98}>, #<Net::IMAP::FetchData seqno=7, attr={"UID"=>99}>, #<Net::IMAP::FetchData seqno=8, attr={"UID"=>100}>]
p im...

...ap.fetch(6, "BODY[HEADER.FIELDS (SUBJECT)]")
#=> [#<Net::IMAP::FetchData seqno=6, attr={"BODY[HEADER.FIELDS (SUBJECT)]"=>"Subject: test\r\n\r\n"}>]
data = imap.uid_fetch(98, ["RFC822.SIZE", "INTERNALDATE"])[0]
p data.seqno
#=> 6
p data.attr["RFC822.SIZE"]
#=> 611
p data.attr["INTERNALD...

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

2.2.0

インスタンスメソッド

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

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

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

G...

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

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

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

2.2.0

インスタンスメソッド

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

...ールボックスの 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] (7.0)

2.2.0

インスタンスメソッド

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

...報を返します。

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

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

@param mailbox quota root を得たいメールボックス名(文字列)
@raise Net::IMAP::NoResponseError 指定したメールボックスが...

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

2.2.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#idle_done -> () (7.0)

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

...集合から
引数にマッチするものすべてを返します。

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

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

@param refname 参...

...ate("foo/bar")
imap.create("foo/baz")
p imap.list("", "foo/%")
#=> [#<Net::IMAP::MailboxList attr=[:Noselect], delim="/", name="foo/">, #<Net::IMAP::MailboxList attr=[:Noinferiors, :Marked], delim="/", name="foo/bar">, #<Net::IMAP::MailboxList attr=[:Noinferiors], delim="/", name="foo/baz">]...

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

2.2.0

インスタンスメソッド

...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 (7.0)

2.2.0

インスタンスメソッド

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

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

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

2.2.0

インスタンスメソッド

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

Net::IMAP#noop -> Net::IMAP::TaggedResponse (7.0)

2.2.0

インスタンスメソッド

NOOP コマンドを送ります。

NOOP コマンドを送ります。

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

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

2.2.0

インスタンスメソッド

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

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

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

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

2.2.0

インスタンスメソッド

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

...ームします。

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

@see Net::IMAP#add_response_handler...

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

2.2.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] (7.0)

2.2.0

インスタンスメソッド

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

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

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

検索の条件は key に文字列の1次元配列もしくは...

...UBJECT", "hello"])
#=> [1, 6, 7, 8]
p imap.search(["SUBJECT", "hello", "FROM", "foo@example.com"])
#=> [6, 7]
p imap.search('SUBJECT "hello"')
#=> [1, 6, 7, 8]

@param key 検索キー(文字列の配列もしくは文字列)
@param charset 検索に用いるcharset
@see Net::IMAP#search...

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

2.2.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#setacl(mailbox, user, rights) (7.0)

2.2.0

インスタンスメソッド

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

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

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

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

絞り込み条件を変える

Net::IMAP#setquota(mailbox, quota) -> Net::IMAP::TaggedResponse (7.0)

2.2.0

インスタンスメソッド

SETQUOTA コマンドを送り、指定したメールボックスに quota を設定します。

...のコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。

@param mailbox quota を設定するメールボックス名(文字列)
@param quota quotaの値(ストレージのサイズ、もしくは nil)
@raise Net::IMAP::NoResponseError 指...

Net::IMAP#sort(sort_keys, search_keys, charset) -> [Integer] (7.0)

2.2.0

インスタンスメソッド

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

...します。

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

sort_keys にはソート順を決めるキーを文字...

...てください。

search_key には検索条件を渡します。Net::IMAP#search と
ほぼ同じです。この条件にマッチするメッセージのみがソートされます。

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

Net::IMAP#starttls(certs, verify) -> Net::IMAP::TaggedResponse (7.0)

2.2.0

インスタンスメソッド

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

...換性のため、certs で証明書or証明書ディレクトリのファイル名(文字列)、
verify で検証するかどうか(Net::IMAP::VERIFY_PEER、
Net::IMAP::VERIFY_NONEに対応します)を
指定することができます。

@param options SSL/TLS のオプション(Hash オブジ...

Net::IMAP#starttls(options) -> Net::IMAP::TaggedResponse (7.0)

2.2.0

インスタンスメソッド

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

Net::IMAP#status(mailbox, attr) -> {String => Integer} (7.0)

2.2.0

インスタンスメソッド

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

...m mailbox 問い合わせ対象のメールボックス(文字列)
@param attr 問合せたいアトリビュート名(文字列)の配列
@raise Net::IMAP::NoResponseError メールボックスが存在しない場合や、
アトリビュート名が存在しない場合に発生します...

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

...セージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。

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

attr で何をどのように変化させるかを指定します。
以...

...た内容を Net::IMAP::FetchData オブジェクトの
配列で返します。

例:

p imap.store(6..8, "+FLAGS", [:Deleted])
#=> [#<Net::IMAP::FetchData seqno=6, attr={"FLAGS"=>[:Seen, :Deleted]}>, #<Net::IMAP::FetchData seqno=7, attr={"FLAGS"=>[:Seen, :Deleted]}>, #<Net::IMAP::FetchData seq...

...no=8, attr={"FLAGS"=>[:Seen, :Deleted]}>]

@param set 更新するメッセージのsequence number
@param attr 更新方式(文字列)
@param flags 更新内容(Symbol の配列)
@see Net::IMAP#uid_store, Net::IMAP#fetch...

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

2.2.0

インスタンスメソッド

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

..."subscribe" なメールボックスの集合に
追加します。

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

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

2.2.0

インスタンスメソッド

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

...ます。

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

algorithm は木構造を決定するためのアルゴ...

...渡します。
Net::IMAP#search と同等です。

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

Net::IMAP#uid_copy(set, mailbox) -> Net::IMAP::TaggedResponse (7.0)

2.2.0

インスタンスメソッド

UID COPY コマンドを送り、指定したメッセージを指定したメールボックスの末尾に追加します。

...ルボックスは
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] (7.0)

2.2.0

インスタンスメソッド

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

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

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

set で対象とするメッセージを指定します。
これ...

...るアトリビュートを文字列の配列で渡してください。
指定可能なアトリビュートについては Net::IMAP::FetchData#attr
を見てください。

@param set 処理対象のメッセージの UID
@param attr アトリビュート(文字列配列)
@see Net::IMAP#fetch...

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

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

...llo"])
#=> [1, 6, 7, 8]
p imap.uid_search(["SUBJECT", "hello", "FROM", "foo@example.com"])
#=> [6, 7]
p imap.uid_search('SUBJECT "hello"')
#=> [1, 6, 7, 8]

@param key 検索キー(文字列の配列もしくは文字列)
@param charset 検索に用いるcharset
@see Net::IMAP#uid_search...

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

2.2.0

インスタンスメソッド

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

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

2.2.0

インスタンスメソッド

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

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

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

attr で何をどのように変化させるかを指定します。
以...

...してください。

返り値は更新された内容を Net::IMAP::FetchData オブジェクトの
配列で返します。

@param set 更新するメッセージの UID
@param attr 更新方式(文字列)
@param flags 更新内容(Symbol の配列)

@see Net::IMAP#store, Net::IMAP#uid_fetch...

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

2.2.0

インスタンスメソッド

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

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

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

@param algor...

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

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

2.2.0

インスタンスメソッド

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

...be" なメールボックスの集合から
削除します。

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

絞り込み条件を変える

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

2.2.0

インスタンスメソッド

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

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

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

詳しくは
http://code.goo...

...imap.create("foo/baz")
p imap.xlist("", "foo/%")
#=> [#<Net::IMAP::MailboxList attr=[:Noselect], delim="/", name="foo/">, \\
# #<Net::IMAP::MailboxList attr=[:Noinferiors, :Marked], delim="/", name="foo/bar">, \\
# #<Net::IMAP::MailboxList attr=[:Noinferiors], delim="/", name="foo/baz"...

ライブラリ

キーワード

検索結果

先頭5件

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

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

Net::IMAP#append(mailbox, message, flags = nil, date_time = nil) -> Net::IMAP::TaggedResponse (7.0)

Net::IMAP#authenticate(auth_type, user, password) -> Net::IMAP::TaggedResponse (7.0)

Net::IMAP#capability -> [String] (7.0)

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

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

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

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

Net::IMAP#copy(set, mailbox) -> Net::IMAP::TaggedResponse (7.0)

Net::IMAP#create(mailbox) -> Net::IMAP::TaggedResponse (7.0)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Net::IMAP#noop -> Net::IMAP::TaggedResponse (7.0)

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

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

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

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

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

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

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

Net::IMAP#setquota(mailbox, quota) -> Net::IMAP::TaggedResponse (7.0)

Net::IMAP#sort(sort_keys, search_keys, charset) -> [Integer] (7.0)

Net::IMAP#starttls(certs, verify) -> Net::IMAP::TaggedResponse (7.0)

Net::IMAP#starttls(options) -> Net::IMAP::TaggedResponse (7.0)

Net::IMAP#status(mailbox, attr) -> {String => Integer} (7.0)

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

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

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

Net::IMAP#uid_copy(set, mailbox) -> Net::IMAP::TaggedResponse (7.0)

Net::IMAP#uid_fetch(set, attr) -> [Net::IMAP::FetchData] (7.0)

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

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

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

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

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

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