クラス
-
Net
:: IMAP (20) -
Net
:: IMAP :: Address (1) -
Net
:: IMAP :: BodyTypeBasic (4) -
Net
:: IMAP :: BodyTypeMessage (5) -
Net
:: IMAP :: BodyTypeMultipart (9) -
Net
:: IMAP :: BodyTypeText (4) -
Net
:: IMAP :: ContinuationRequest (2) -
Net
:: IMAP :: Envelope (1) -
Net
:: IMAP :: MailboxACLItem (1) -
Net
:: IMAP :: MailboxQuota (3) -
Net
:: IMAP :: MailboxQuotaRoot (2) -
Net
:: IMAP :: ResponseError (1) -
Net
:: IMAP :: StatusData (2) -
Net
:: IMAP :: UntaggedResponse (3)
キーワード
- attr (1)
- authenticate (1)
- body (1)
- data (2)
- disposition (1)
- expunge (1)
- extension (1)
- getquota (1)
- getquotaroot (1)
- greeting (1)
- language (4)
- login (1)
- logout (1)
- lsub (1)
- mailbox (3)
-
media
_ subtype (4) -
media
_ type (1) - multipart? (4)
- name (1)
- param (1)
- parts (1)
- quota (1)
- quotaroots (1)
-
raw
_ data (2) - response (1)
- route (1)
- setacl (1)
- setquota (1)
- status (1)
- subject (1)
- subscribe (1)
- subtype (4)
-
uid
_ copy (1) -
uid
_ fetch (1) -
uid
_ move (1) -
uid
_ search (1) -
uid
_ sort (1) -
uid
_ store (1) -
uid
_ thread (1) - unsubscribe (1)
- usage (1)
- user (1)
検索結果
先頭5件
- Net
:: IMAP :: BodyTypeMultipart # multipart? -> bool - Net
:: IMAP :: MailboxQuota # quota -> Integer - Net
:: IMAP :: MailboxQuotaRoot # quotaroots -> [String] - Net
:: IMAP # getquotaroot(mailbox) -> [Net :: IMAP :: MailboxQuotaRoot | Net :: IMAP :: MailboxQuota] - Net
:: IMAP # authenticate(auth _ type , user , password) -> Net :: IMAP :: TaggedResponse
-
Net
:: IMAP :: BodyTypeMultipart # multipart? -> bool (27310.0) -
マルチパートかどうかを返します。 true を返します。
マルチパートかどうかを返します。
true を返します。 -
Net
:: IMAP :: MailboxQuota # quota -> Integer (27310.0) -
メールボックスに指定されている上限値を返します。
メールボックスに指定されている上限値を返します。 -
Net
:: IMAP :: MailboxQuotaRoot # quotaroots -> [String] (27310.0) -
問い合わせしたメールボックスの quota root 名を配列で返します。
問い合わせしたメールボックスの quota root 名を配列で返します。
空の場合もありえます。 -
Net
:: IMAP # getquotaroot(mailbox) -> [Net :: IMAP :: MailboxQuotaRoot | Net :: IMAP :: MailboxQuota] (18910.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 # authenticate(auth _ type , user , password) -> Net :: IMAP :: TaggedResponse (18610.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 # getquota(mailbox) -> [Net :: IMAP :: MailboxQuota] (18610.0) -
GETQUOTA コマンドを送って 指定したメールボックスの quota の情報を返します。
GETQUOTA コマンドを送って
指定したメールボックスの quota の情報を返します。
quota の情報は Net::IMAP::MailboxQuota オブジェクトの配列で
得られます。
詳しくは 2087 を見てください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
@param mailbox quota 情報を得たいメールボックス名
@raise Net::IMAP::NoResponseError 指定したメールボックスが quota root でない場合に発生します -
Net
:: IMAP # setquota(mailbox , quota) -> Net :: IMAP :: TaggedResponse (18610.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 # expunge -> [Integer] | nil (18310.0) -
EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを すべて処理中のメールボックスから削除します。
EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを
すべて処理中のメールボックスから削除します。
削除したメッセージの message sequence number を配列で返します。
@raise Net::IMAP::NoResponseError メールボックスが read-only である場合に発生します -
Net
:: IMAP # logout -> Net :: IMAP :: TaggedResponse (18310.0) -
LOGOUT コマンドを送り、コネクションを切断することを サーバに伝えます。
LOGOUT コマンドを送り、コネクションを切断することを
サーバに伝えます。 -
Net
:: IMAP # lsub(refname , mailbox) -> [Net :: IMAP :: MailboxList] (18310.0) -
LIST コマンドを送り、active/subscribed なメールボックス名の集合から 引数にマッチするものすべてを返します。
LIST コマンドを送り、active/subscribed なメールボックス名の集合から
引数にマッチするものすべてを返します。
詳しくは 2060 の 6.3.8 を参照してください。
返り値は Net::IMAP::MailboxList の配列で返します。
返り値が空集合である場合は空の配列でなく nil を返します。
@param refname 参照名(文字列)
@param mailbox 調べるメールボックスの名前(文字列)。ワイルドカードを含んでいてもかまいません。 -
Net
:: IMAP # status(mailbox , attr) -> {String => Integer} (18310.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 # subscribe(mailbox) -> Net :: IMAP :: TaggedResponse (18310.0) -
SUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合に 追加します。
SUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合に
追加します。
@param mailbox 追加するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
追加できなかった場合に発生します。
指定した名前のメールボックスが存在しない場合などに
生じます。 -
Net
:: IMAP # uid _ copy(set , mailbox) -> Net :: IMAP :: TaggedResponse (18310.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] (18310.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 (18310.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] (18310.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 _ store(set , attr , flags) -> [Net :: IMAP :: FetchData] | nil (18310.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] (18310.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 (18310.0) -
UNSUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合から 削除します。
UNSUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合から
削除します。
@param mailbox 削除するするメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
削除できなかった場合に発生します。
指定した名前のメールボックスが active/subscribe でなかった
場合などに発生します。 -
Net
:: IMAP :: Address # route -> String | nil (18310.0) -
メールアドレスの SMTP at-domain-list を返します。
メールアドレスの SMTP at-domain-list を返します。
存在しない場合は nil を返します。
通常は nil を返します。 -
Net
:: IMAP :: BodyTypeBasic # language -> String | [String] | nil (18310.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeBasic # media _ subtype -> String (18310.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeBasic#media_type -
Net
:: IMAP :: BodyTypeBasic # multipart? -> bool (18310.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: BodyTypeBasic # subtype -> String (18310.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeBasic#media_type -
Net
:: IMAP :: BodyTypeMessage # language -> String | [String] | nil (18310.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeMessage # media _ subtype -> String (18310.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeMessage#media_type -
Net
:: IMAP :: BodyTypeMessage # multipart? -> bool (18310.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: BodyTypeMessage # subtype -> String (18310.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeMessage#media_type -
Net
:: IMAP :: BodyTypeMultipart # language -> String | [String] | nil (18310.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeMultipart # media _ subtype -> String (18310.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see 2045, Net::IMAP::BodyTypeText#media_type -
Net
:: IMAP :: BodyTypeMultipart # subtype -> String (18310.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see 2045, Net::IMAP::BodyTypeText#media_type -
Net
:: IMAP :: BodyTypeText # language -> String | [String] | nil (18310.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeText # media _ subtype -> String (18310.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeText#media_type -
Net
:: IMAP :: BodyTypeText # multipart? -> bool (18310.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: BodyTypeText # subtype -> String (18310.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeText#media_type -
Net
:: IMAP :: Envelope # subject -> String | nil (18310.0) -
メッセージのサブジェクトを返します。
メッセージのサブジェクトを返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: MailboxACLItem # user -> String (18310.0) -
ユーザ名を返します。
ユーザ名を返します。
このユーザは
Net::IMAP#getacl で指定したメールボックスに
対し何らかの権限を持っています。 -
Net
:: IMAP :: MailboxQuota # usage -> Integer (18310.0) -
現在のメールボックス内の使用量を返します。
現在のメールボックス内の使用量を返します。 -
Net
:: IMAP # uid _ sort(sort _ keys , search _ keys , charset) -> [Integer] (9310.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 :: BodyTypeMultipart # parts -> [Net :: IMAP :: BodyTypeBasic | Net :: IMAP :: BodyTypeText | Net :: IMAP :: BodyTypeMessage | Net :: IMAP :: BodyTypeMultipart] (9310.0) -
マルチパートの各部分を返します。
マルチパートの各部分を返します。 -
Net
:: IMAP :: BodyTypeMultipart # disposition -> Net :: IMAP :: ContentDisposition | nil (9010.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMultipart # extension -> Array | nil (9010.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeMultipart # media _ type -> String (9010.0) -
MIME のメディアタイプを返します。
MIME のメディアタイプを返します。
"MULTIPART" を返します。
@see Net::IMAP::BodyTypeMultipart#subtype -
Net
:: IMAP :: BodyTypeMultipart # param -> { String => String } (9010.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: ContinuationRequest # data -> Net :: IMAP :: ResponseText (9010.0) -
レスポンスのデータを返します。
レスポンスのデータを返します。 -
Net
:: IMAP :: ContinuationRequest # raw _ data -> String (9010.0) -
レスポンス文字列を返します。
レスポンス文字列を返します。 -
Net
:: IMAP :: MailboxQuota # mailbox -> String (9010.0) -
quota が設定されているメールボックスの名前を返します。
quota が設定されているメールボックスの名前を返します。 -
Net
:: IMAP :: MailboxQuotaRoot # mailbox -> String (9010.0) -
問い合わせしたメールボックスの名前を返します。
問い合わせしたメールボックスの名前を返します。 -
Net
:: IMAP :: StatusData # attr -> { String => Integer } (9010.0) -
STATUS 応答の内容をハッシュで返します。
STATUS 応答の内容をハッシュで返します。
ハッシュのキーは
"MESSAGES", "RECENT", "UIDNEXT", "UIDVALIDITY", "UNSEEN"
などが使われます。
詳しくは 2060 の 6.3.10、7.2.4 を見てください。 -
Net
:: IMAP :: StatusData # mailbox -> String (9010.0) -
メールボックス名を返します。
メールボックス名を返します。 -
Net
:: IMAP :: UntaggedResponse # data -> object (9010.0) -
レスポンスを解析した結果のオブジェクトを返します。
レスポンスを解析した結果のオブジェクトを返します。
レスポンスによって異なるオブジェクトを返します。
Net::IMAP::MailboxList であったりフラグを表わす
シンボルの配列であったりします。 -
Net
:: IMAP :: UntaggedResponse # name -> String (9010.0) -
レスポンスの名前(種類)を返します。
レスポンスの名前(種類)を返します。
例えば以下のような値を返します。これらの具体的な意味は
2060 を参考にしてください。
* "OK"
* "NO"
* "BAD"
* "BYE"
* "PREAUTH"
* "CAPABILITY"
* "LIST"
* "FLAGS"
* etc -
Net
:: IMAP :: UntaggedResponse # raw _ data -> String (9010.0) -
レスポンス文字列を返します。
レスポンス文字列を返します。
@see Net::IMAP::UntaggedResponse#data -
Net
:: IMAP # greeting -> Net :: IMAP :: UntaggedResponse (310.0) -
サーバから最初に送られてくるメッセージ(greeting message) を返します。
サーバから最初に送られてくるメッセージ(greeting message)
を返します。 -
Net
:: IMAP # login(user , password) -> Net :: IMAP :: TaggedResponse (310.0) -
LOGIN コマンドを送り、平文でパスワードを送りクライアント ユーザを認証します。
LOGIN コマンドを送り、平文でパスワードを送りクライアント
ユーザを認証します。
Net::IMAP#authenticate で "LOGIN" を使うのとは異なる
ことに注意してください。authenticate では AUTHENTICATE コマンドを
送ります。
認証成功時には
認証成功レスポンスを返り値として返します。
認証失敗時には例外が発生します。
@param user ユーザ名文字列
@param password パスワード文字列
@raise Net::IMAP::NoResponseError 認証に失敗した場合に発生します
@see Net::IMAP#... -
Net
:: IMAP # setacl(mailbox , user , rights) (310.0) -
SETACL コマンドを送り、指定したメールボックスに 指定したユーザに関する権限を設定します。
SETACL コマンドを送り、指定したメールボックスに
指定したユーザに関する権限を設定します。
rights には設定する権限を表す文字列を指定します。
どのような文字列を指定すべきかは 2086 を参照してください。
rights に nil を渡すと、空文字列を指定したのと同様、つまり
すべての権限を削除します。
@param mailbox 権限を設定するメールボックスの名前(文字列)
@param user 権限を設定するユーザの名前(文字列)
@param rights 権限を表す文字列 -
Net
:: IMAP :: BodyTypeMessage # body -> Net :: IMAP :: BodyTypeBasic | Net :: IMAP :: BodyTypeMessage | Net :: IMAP :: BodyTypeText | Net :: IMAP :: BodyTypeMultipart (310.0) -
ボディを返します。
ボディを返します。 -
Net
:: IMAP :: ResponseError # response -> Net :: IMAP :: TaggedResponse | Net :: IMAP :: UntaggedResponse (310.0) -
エラーとなったレスポンスを表すオブジェクトを返します。
エラーとなったレスポンスを表すオブジェクトを返します。