クラス
-
Net
:: IMAP (44) -
Net
:: IMAP :: Address (4) -
Net
:: IMAP :: BodyTypeBasic (8) -
Net
:: IMAP :: BodyTypeMessage (11) -
Net
:: IMAP :: BodyTypeMultipart (9) -
Net
:: IMAP :: BodyTypeText (9) -
Net
:: IMAP :: ContentDisposition (1) -
Net
:: IMAP :: Envelope (10) -
Net
:: IMAP :: MailboxACLItem (2) -
Net
:: IMAP :: MailboxList (3) -
Net
:: IMAP :: MailboxQuota (3) -
Net
:: IMAP :: MailboxQuotaRoot (2) -
Net
:: IMAP :: ResponseCode (1) -
Net
:: IMAP :: ResponseText (1) -
Net
:: IMAP :: StatusData (1) -
Net
:: IMAP :: ThreadMember (2)
キーワード
-
add
_ response _ handler (2) - append (1)
- attr (1)
- bcc (1)
- body (1)
- capability (1)
- cc (1)
- children (1)
-
client
_ thread (1) -
client
_ thread= (1) - close (1)
- code (1)
-
content
_ id (3) - copy (1)
- create (1)
- data (1)
- date (1)
- delete (1)
- delim (1)
- description (3)
- disconnect (1)
- disconnected? (1)
- disposition (4)
- envelope (1)
- examine (1)
- expunge (1)
- extension (4)
- from (1)
- getacl (1)
- getquota (1)
- getquotaroot (1)
- host (1)
- idle (1)
-
idle
_ done (1) -
in
_ reply _ to (1) - language (4)
- lines (2)
- list (1)
- login (1)
- logout (1)
- lsub (1)
- mailbox (4)
- md5 (3)
-
media
_ subtype (1) -
media
_ type (1) - move (1)
- multipart? (4)
- name (2)
- param (5)
- parts (1)
- quota (1)
- quotaroots (1)
-
remove
_ response _ handler (1) - rename (1)
-
reply
_ to (1) -
response
_ handlers (1) - rights (1)
- route (1)
- search (1)
- select (1)
- sender (1)
- seqno (1)
- setacl (1)
- setquota (1)
- starttls (2)
- status (1)
- store (1)
- subject (1)
- subscribe (1)
- subtype (1)
- thread (1)
- to (1)
-
uid
_ copy (1) -
uid
_ move (1) -
uid
_ search (1) -
uid
_ store (1) -
uid
_ thread (1) - unsubscribe (1)
- usage (1)
- user (1)
- xlist (1)
検索結果
先頭5件
-
Net
:: IMAP :: BodyTypeMultipart # multipart? -> bool (27310.0) -
マルチパートかどうかを返します。 true を返します。
マルチパートかどうかを返します。
true を返します。 -
Net
:: IMAP :: MailboxQuota # mailbox -> String (27310.0) -
quota が設定されているメールボックスの名前を返します。
quota が設定されているメールボックスの名前を返します。 -
Net
:: IMAP :: MailboxQuotaRoot # mailbox -> String (27310.0) -
問い合わせしたメールボックスの名前を返します。
問い合わせしたメールボックスの名前を返します。 -
Net
:: IMAP # add _ response _ handler(handler) -> () (18610.0) -
レスポンスハンドラを追加します。
レスポンスハンドラを追加します。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。
レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_respo... -
Net
:: IMAP # add _ response _ handler(handler) {|resp| . . . } -> () (18610.0) -
レスポンスハンドラを追加します。
レスポンスハンドラを追加します。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。
レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_respo... -
Net
:: IMAP # list(refname , mailbox) -> [Net :: IMAP :: MailboxList] | nil (18610.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 # remove _ response _ handler(handler) -> () (18610.0) -
レスポンスハンドラを削除します。
レスポンスハンドラを削除します。
@param handler 削除するハンドラ
@see Net::IMAP#add_response_handler -
Net
:: IMAP # xlist(refname , mailbox) -> [Net :: IMAP :: MailboxList] (18610.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 # capability -> [String] (18310.0) -
CAPABILITY コマンドを送ってサーバがサポートしている 機能(capabilities)のリストを文字列の配列として返します。
CAPABILITY コマンドを送ってサーバがサポートしている
機能(capabilities)のリストを文字列の配列として返します。
capability は IMAP に関連する RFC などで定義されています。
imap.capability
# => ["IMAP4REV1", "UNSELECT", "IDLE", "NAMESPACE", "QUOTA", ... ] -
Net
:: IMAP # client _ thread -> Thread (18310.0) -
このメソッドは obsolete です。使わないでください。
このメソッドは obsolete です。使わないでください。 -
Net
:: IMAP # client _ thread=(th) (18310.0) -
このメソッドは obsolete です。使わないでください。
このメソッドは obsolete です。使わないでください。 -
Net
:: IMAP # close -> Net :: IMAP :: TaggedResponse (18310.0) -
CLOSE コマンドを送り、処理中のメールボックスを閉じます。
CLOSE コマンドを送り、処理中のメールボックスを閉じます。
このコマンドによって、どのメールボックスも選択されていない
状態に移行します。
そして \Deleted フラグが付けられたメールがすべて削除されます。 -
Net
:: IMAP # delete(mailbox) -> Net :: IMAP :: TaggedResponse (18310.0) -
DELETE コマンドを送り、指定したメールボックスを削除します。
DELETE コマンドを送り、指定したメールボックスを削除します。
@param mailbox 削除するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを削除できなかった場合
に発生します。指定した名前のメールボックスが存在しない場合や、
ユーザにメールボックスを削除する権限がない場合に発生します。 -
Net
:: IMAP # getacl(mailbox) -> [Net :: IMAP :: MailboxACLItem] (18310.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 # idle {|resp| . . . } -> Net :: IMAP :: TaggedResponse (18310.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 -> () (18310.0) -
Net::IMAP#idle で 停止しているスレッドを1つ起こします。
Net::IMAP#idle で
停止しているスレッドを1つ起こします。 -
Net
:: IMAP # login(user , password) -> Net :: IMAP :: TaggedResponse (18310.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 (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 # response _ handlers -> Array (18310.0) -
設定されているレスポンスハンドラ全てを 配列で返します。
設定されているレスポンスハンドラ全てを
配列で返します。
@see Net::IMAP#add_response_handler -
Net
:: IMAP # select(mailbox) -> Net :: IMAP :: TaggedResponse (18310.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) (18310.0) -
SETACL コマンドを送り、指定したメールボックスに 指定したユーザに関する権限を設定します。
SETACL コマンドを送り、指定したメールボックスに
指定したユーザに関する権限を設定します。
rights には設定する権限を表す文字列を指定します。
どのような文字列を指定すべきかは 2086 を参照してください。
rights に nil を渡すと、空文字列を指定したのと同様、つまり
すべての権限を削除します。
@param mailbox 権限を設定するメールボックスの名前(文字列)
@param user 権限を設定するユーザの名前(文字列)
@param rights 権限を表す文字列 -
Net
:: IMAP # starttls(certs , verify) -> Net :: IMAP :: TaggedResponse (18310.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 (18310.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 :: Address # mailbox -> String | nil (18310.0) -
メールアドレスのメールボックス名を返します。
メールアドレスのメールボックス名を返します。
これが nil ならばそれは 822 group の終わりを意味します。
これが nil でなく、Net::IMAP::Address#mailbox が nil ならば、
822 のグループ名を表します。
どれでもなければ、822 の local-part を表します。
通常は、メールアドレスの「@」の手前を返します。 -
Net
:: IMAP :: BodyTypeBasic # language -> String | [String] | nil (18310.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeBasic # multipart? -> bool (18310.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: BodyTypeMessage # envelope -> Net :: IMAP :: Envelpe | nil (18310.0) -
メッセージのエンベロープを返します。
メッセージのエンベロープを返します。 -
Net
:: IMAP :: BodyTypeMessage # language -> String | [String] | nil (18310.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeMessage # lines -> Integer (18310.0) -
ボディのテキストの行数を返します。
ボディのテキストの行数を返します。 -
Net
:: IMAP :: BodyTypeMessage # multipart? -> bool (18310.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: BodyTypeMultipart # language -> String | [String] | nil (18310.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeText # language -> String | [String] | nil (18310.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeText # lines -> Integer (18310.0) -
ボディの行数を返します。
ボディの行数を返します。 -
Net
:: IMAP :: BodyTypeText # multipart? -> bool (18310.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: Envelope # in _ reply _ to -> String | nil (18310.0) -
In-reply-to の内容を文字列で返します。
In-reply-to の内容を文字列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # reply _ to -> [Net :: IMAP :: Address] | nil (18310.0) -
Reply-To を Net::IMAP::Address オブジェクトの配列で返します。
Reply-To を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: MailboxList # delim -> String|nil (18310.0) -
階層区切り文字列を返します。
階層区切り文字列を返します。
まったく階層が存在しない場合は nil を返します。 -
Net
:: IMAP :: StatusData # mailbox -> String (18310.0) -
メールボックス名を返します。
メールボックス名を返します。 -
Net
:: IMAP :: ThreadMember # children -> [Net :: IMAP :: ThreadMember] (18310.0) -
スレッドの木構造における自身の下位の部分を返します。
スレッドの木構造における自身の下位の部分を返します。 -
Net
:: IMAP :: BodyTypeMultipart # disposition -> Net :: IMAP :: ContentDisposition | nil (9310.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMultipart # extension -> Array | nil (9310.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeMultipart # parts -> [Net :: IMAP :: BodyTypeBasic | Net :: IMAP :: BodyTypeText | Net :: IMAP :: BodyTypeMessage | Net :: IMAP :: BodyTypeMultipart] (9310.0) -
マルチパートの各部分を返します。
マルチパートの各部分を返します。 -
Net
:: IMAP :: Envelope # bcc -> [Net :: IMAP :: Address] | nil (9310.0) -
Bcc を Net::IMAP::Address オブジェクトの配列で返します。
Bcc を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # cc -> [Net :: IMAP :: Address] | nil (9310.0) -
Cc を Net::IMAP::Address オブジェクトの配列で返します。
Cc を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # date -> String | nil (9310.0) -
日付の文字列を返します。
日付の文字列を返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # from -> [Net :: IMAP :: Address] | nil (9310.0) -
From を Net::IMAP::Address オブジェクトの配列で返します。
From を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # message _ id -> String | nil (9310.0) -
message_id を文字列で返します。
message_id を文字列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # sender -> [Net :: IMAP :: Address] | nil (9310.0) -
Sender を Net::IMAP::Address オブジェクトの配列で返します。
Sender を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # subject -> String | nil (9310.0) -
メッセージのサブジェクトを返します。
メッセージのサブジェクトを返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # to -> [Net :: IMAP :: Address] | nil (9310.0) -
To を Net::IMAP::Address オブジェクトの配列で返します。
To を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: MailboxList # attr -> [Symbol] (9310.0) -
メールボックスの属性をシンボルの配列で返します。
メールボックスの属性をシンボルの配列で返します。
これで得られるシンボルは String#capitalize でキャピタライズ
されています。
この配列には例えば以下のような値を含んでいます。
詳しくは 2060 7.2.2 などを参照してください。
以下のもの以外で、IMAP 関連 RFC で拡張された値を含んでいる
場合もあります
* :Noselect
* :Noinferiors
* :Marked
* :Unmarked -
Net
:: IMAP :: BodyTypeMultipart # media _ subtype -> String (9010.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see 2045, Net::IMAP::BodyTypeText#media_type -
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 :: BodyTypeMultipart # subtype -> String (9010.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see 2045, Net::IMAP::BodyTypeText#media_type -
Net
:: IMAP :: MailboxACLItem # rights -> String (9010.0) -
アクセス権限を文字列で返します。
アクセス権限を文字列で返します。
Net::IMAP::MailboxACLItem#user で得られるユーザが
持っている権限が返されます。
この文字列の意味については 2086 を参照してください。 -
Net
:: IMAP :: MailboxACLItem # user -> String (9010.0) -
ユーザ名を返します。
ユーザ名を返します。
このユーザは
Net::IMAP#getacl で指定したメールボックスに
対し何らかの権限を持っています。 -
Net
:: IMAP :: MailboxList # name -> String (9010.0) -
メールボックスの名前を文字列で返します。
メールボックスの名前を文字列で返します。 -
Net
:: IMAP :: MailboxQuota # quota -> Integer (9010.0) -
メールボックスに指定されている上限値を返します。
メールボックスに指定されている上限値を返します。 -
Net
:: IMAP :: MailboxQuota # usage -> Integer (9010.0) -
現在のメールボックス内の使用量を返します。
現在のメールボックス内の使用量を返します。 -
Net
:: IMAP :: MailboxQuotaRoot # quotaroots -> [String] (9010.0) -
問い合わせしたメールボックスの quota root 名を配列で返します。
問い合わせしたメールボックスの quota root 名を配列で返します。
空の場合もありえます。 -
Net
:: IMAP # getquotaroot(mailbox) -> [Net :: IMAP :: MailboxQuotaRoot | Net :: IMAP :: MailboxQuota] (910.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 # getquota(mailbox) -> [Net :: IMAP :: MailboxQuota] (610.0) -
GETQUOTA コマンドを送って 指定したメールボックスの quota の情報を返します。
GETQUOTA コマンドを送って
指定したメールボックスの quota の情報を返します。
quota の情報は Net::IMAP::MailboxQuota オブジェクトの配列で
得られます。
詳しくは 2087 を見てください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
@param mailbox quota 情報を得たいメールボックス名
@raise Net::IMAP::NoResponseError 指定したメールボックスが quota root でない場合に発生します -
Net
:: IMAP # append(mailbox , message , flags = nil , date _ time = nil) -> Net :: IMAP :: TaggedResponse (310.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 # copy(set , mailbox) -> Net :: IMAP :: TaggedResponse (310.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 (310.0) -
CREATE コマンドを送り、新しいメールボックスを作ります。
CREATE コマンドを送り、新しいメールボックスを作ります。
@param mailbox 新しいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスが作れなかった場合に発生します -
Net
:: IMAP # disconnect -> nil (310.0) -
サーバとの接続を切断します。
サーバとの接続を切断します。
@see Net::IMAP#disconnected? -
Net
:: IMAP # disconnected? -> bool (310.0) -
サーバとの接続が切断されていれば真を返します。
サーバとの接続が切断されていれば真を返します。
@see Net::IMAP#disconnect -
Net
:: IMAP # examine(mailbox) -> Net :: IMAP :: TaggedResponse (310.0) -
EXAMINE コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。
EXAMINE コマンドを送り、指定したメールボックスを処理対象の
メールボックスにします。
Net::IMAP#select と異なりセッション中はメールボックスが
読み取り専用となります。それ以外は select と同じです。
@param mailbox 処理対象としたいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError mailboxが存在しない等の理由でコマンドの実行に失敗
した場合に発生します。 -
Net
:: IMAP # expunge -> [Integer] | nil (310.0) -
EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを すべて処理中のメールボックスから削除します。
EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを
すべて処理中のメールボックスから削除します。
削除したメッセージの message sequence number を配列で返します。
@raise Net::IMAP::NoResponseError メールボックスが read-only である場合に発生します -
Net
:: IMAP # move(set , mailbox) -> Net :: IMAP :: TaggedResponse (310.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 # rename(mailbox , newname) -> Net :: IMAP :: TaggedResponse (310.0) -
RENAME コマンドを送り、指定したメールボックスをリネームします。
RENAME コマンドを送り、指定したメールボックスをリネームします。
@param mailbox リネームするメールボックス(文字列)
@param newname リネーム後の名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
リネームできなかった場合に発生します。
指定した名前のメールボックスが存在しない場合や、
リネーム後の名前を持つメールボックスが既に存在する
場合に発生します。 -
Net
:: IMAP # search(keys , charset = nil) -> [Integer] (310.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 # setquota(mailbox , quota) -> Net :: IMAP :: TaggedResponse (310.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 # status(mailbox , attr) -> {String => Integer} (310.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 (310.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 (310.0) -
SUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合に 追加します。
SUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合に
追加します。
@param mailbox 追加するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
追加できなかった場合に発生します。
指定した名前のメールボックスが存在しない場合などに
生じます。 -
Net
:: IMAP # thread(algorithm , search _ keys , charset) -> [Net :: IMAP :: ThreadMember] (310.0) -
THREADコマンドを送り、メールボックスを検索した結果を スレッド形式の木構造で返します。
THREADコマンドを送り、メールボックスを検索した結果を
スレッド形式の木構造で返します。
THREAD コマンドは 5256 で定義されています。
詳しくはそちらを参照してください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
algorithm は木構造を決定するためのアルゴリズムを指定します。
以下の2つが利用可能です。
* "ORDEREDSUBJECT" subjectを使って平坦に区切るだけ
* "REFERENCES" どのメッセージに返事をしているかを見て木構造を作る
詳しくは 5256 を見てく... -
Net
:: IMAP # uid _ copy(set , mailbox) -> Net :: IMAP :: TaggedResponse (310.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 (310.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] (310.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 (310.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] (310.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 (310.0) -
UNSUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合から 削除します。
UNSUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合から
削除します。
@param mailbox 削除するするメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
削除できなかった場合に発生します。
指定した名前のメールボックスが active/subscribe でなかった
場合などに発生します。 -
Net
:: IMAP :: Address # host -> String | nil (310.0) -
メールアドレスのホスト名を返します。
メールアドレスのホスト名を返します。
nil は 822 のグループ文法に対応します。
これについては Net::IMAP::Address#mailbox も参照してください。
そうでない場合は 822 のドメイン名を表します。
通常は、メールアドレスの「@」の後ろのドメイン名を返します。 -
Net
:: IMAP :: Address # name -> String | nil (310.0) -
メールアドレスの 822 の個人名(personal name)を返します。
メールアドレスの 822 の個人名(personal name)を返します。
個人名が存在しない場合は nil を返します。
通常は nil を返します。 -
Net
:: IMAP :: Address # route -> String | nil (310.0) -
メールアドレスの SMTP at-domain-list を返します。
メールアドレスの SMTP at-domain-list を返します。
存在しない場合は nil を返します。
通常は nil を返します。 -
Net
:: IMAP :: BodyTypeBasic # content _ id -> String | nil (310.0) -
Content-ID の値を文字列で返します。
Content-ID の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeBasic # description -> String | nil (310.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeBasic # disposition -> Net :: IMAP :: ContentDisposition | nil (310.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeBasic # extension -> Array | nil (310.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeBasic # md5 -> String | nil (310.0) -
ボディの MD5 値を文字列で返します。
ボディの MD5 値を文字列で返します。 -
Net
:: IMAP :: BodyTypeBasic # param -> { String => String } | nil (310.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # body -> Net :: IMAP :: BodyTypeBasic | Net :: IMAP :: BodyTypeMessage | Net :: IMAP :: BodyTypeText | Net :: IMAP :: BodyTypeMultipart (310.0) -
ボディを返します。
ボディを返します。 -
Net
:: IMAP :: BodyTypeMessage # content _ id -> String | nil (310.0) -
Content-ID の値を文字列で返します。
Content-ID の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # description -> String | nil (310.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # disposition -> Net :: IMAP :: ContentDisposition | nil (310.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMessage # extension -> Array | nil (310.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeMessage # md5 -> String | nil (310.0) -
ボディの MD5 値を文字列で返します。
ボディの MD5 値を文字列で返します。