種類
- インスタンスメソッド (143)
- クラス (17)
- 特異メソッド (12)
- 定数 (6)
クラス
-
Net
:: IMAP (66) -
Net
:: IMAP :: Address (4) -
Net
:: IMAP :: BodyTypeBasic (12) -
Net
:: IMAP :: BodyTypeMessage (14) -
Net
:: IMAP :: BodyTypeMultipart (9) -
Net
:: IMAP :: BodyTypeText (13) -
Net
:: IMAP :: ContentDisposition (2) -
Net
:: IMAP :: ContinuationRequest (2) -
Net
:: IMAP :: Envelope (10) -
Net
:: IMAP :: FetchData (2) -
Net
:: IMAP :: MailboxACLItem (2) -
Net
:: IMAP :: MailboxList (3) -
Net
:: IMAP :: MailboxQuota (3) -
Net
:: IMAP :: MailboxQuotaRoot (2) -
Net
:: IMAP :: ResponseCode (2) -
Net
:: IMAP :: ResponseError (2) -
Net
:: IMAP :: ResponseText (2) -
Net
:: IMAP :: StatusData (2) -
Net
:: IMAP :: TaggedResponse (4) -
Net
:: IMAP :: ThreadMember (2) -
Net
:: IMAP :: UntaggedResponse (3)
キーワード
- ANSWERED (1)
- Address (1)
- BadResponseError (1)
- BodyTypeMultipart (1)
- ByeResponseError (1)
- ContinuationRequest (1)
- DRAFT (1)
- DataFormatError (1)
- Error (1)
- FlagCountError (1)
- MARKED (1)
- MailboxQuotaRoot (1)
- NOINFERIORS (1)
- NoResponseError (1)
- RECENT (1)
- ResponseCode (1)
- ResponseError (1)
- ResponseParseError (1)
- ResponseText (1)
- TaggedResponse (1)
- ThreadMember (1)
- UNMARKED (1)
- UntaggedResponse (1)
-
add
_ authenticator (1) -
add
_ response _ handler (2) - append (1)
- attr (3)
- authenticate (1)
- bcc (1)
- body (1)
- capability (1)
- cc (1)
- check (1)
- children (1)
-
client
_ thread (1) -
client
_ thread= (1) - close (1)
- code (1)
-
content
_ id (3) - copy (1)
- create (1)
- data (4)
- date (1)
-
decode
_ utf7 (1) -
default
_ imap _ port (1) -
default
_ imaps _ port (1) -
default
_ port (1) -
default
_ ssl _ port (1) -
default
_ tls _ port (1) - delete (1)
- delim (1)
- description (3)
- disposition (1)
-
dsp
_ type (1) -
encode
_ utf7 (1) - encoding (3)
- examine (1)
- expunge (1)
- extension (4)
- fetch (1)
-
format
_ date (1) -
format
_ datetime (1) - from (1)
- getquotaroot (1)
- greeting (1)
- host (1)
- idle (1)
-
in
_ reply _ to (1) - language (4)
- lines (2)
- list (1)
- login (1)
- logout (1)
- lsub (1)
- mailbox (4)
-
max
_ flag _ count (1) - md5 (3)
-
media
_ subtype (4) -
media
_ type (4) - move (1)
- multipart? (4)
- name (5)
- new (1)
- noop (1)
- param (5)
- parts (1)
- quota (1)
- quotaroots (1)
-
raw
_ data (3) -
remove
_ response _ handler (1) - rename (1)
-
reply
_ to (1) - response (1)
- response= (1)
-
response
_ handlers (1) - responses (1)
- rights (1)
- route (1)
- search (1)
- select (1)
- sender (1)
- seqno (2)
- setacl (1)
- setquota (1)
- size (3)
- sort (1)
- starttls (2)
- status (1)
- store (1)
- subject (1)
- subscribe (1)
- subtype (4)
- tag (1)
- text (1)
- thread (1)
- to (1)
-
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)
- xlist (1)
検索結果
先頭5件
- Net
:: IMAP :: BodyTypeMultipart # parts -> [Net :: IMAP :: BodyTypeBasic | Net :: IMAP :: BodyTypeText | Net :: IMAP :: BodyTypeMessage | Net :: IMAP :: BodyTypeMultipart] - Net
:: IMAP # remove _ response _ handler(handler) -> () - Net
:: IMAP :: BodyTypeMultipart # multipart? -> bool - Net
:: IMAP :: MailboxQuotaRoot # quotaroots -> [String] - Net
:: IMAP :: ContinuationRequest
-
Net
:: IMAP :: BodyTypeMultipart # parts -> [Net :: IMAP :: BodyTypeBasic | Net :: IMAP :: BodyTypeText | Net :: IMAP :: BodyTypeMessage | Net :: IMAP :: BodyTypeMultipart] (45907.0) -
マルチパートの各部分を返します。
マルチパートの各部分を返します。 -
Net
:: IMAP # remove _ response _ handler(handler) -> () (45607.0) -
レスポンスハンドラを削除します。
レスポンスハンドラを削除します。
@param handler 削除するハンドラ
@see Net::IMAP#add_response_handler -
Net
:: IMAP :: BodyTypeMultipart # multipart? -> bool (45607.0) -
マルチパートかどうかを返します。 true を返します。
マルチパートかどうかを返します。
true を返します。 -
Net
:: IMAP :: MailboxQuotaRoot # quotaroots -> [String] (45607.0) -
問い合わせしたメールボックスの quota root 名を配列で返します。
問い合わせしたメールボックスの quota root 名を配列で返します。
空の場合もありえます。 -
Net
:: IMAP :: ContinuationRequest (45007.0) -
IMAP の continuation request (命令継続要求) を表すクラスです。
IMAP の continuation request (命令継続要求) を表すクラスです。
通常このクラスを直接扱うことはありません。
レスポンスハンドラ(Net::IMAP#add_response_handler)
に渡されます。
詳しくは 2060 の 7.5 を参照してください。 -
Net
:: IMAP # thread(algorithm , search _ keys , charset) -> [Net :: IMAP :: ThreadMember] (37507.0) -
THREADコマンドを送り、メールボックスを検索した結果を スレッド形式の木構造で返します。
THREADコマンドを送り、メールボックスを検索した結果を
スレッド形式の木構造で返します。
THREAD コマンドは 5256 で定義されています。
詳しくはそちらを参照してください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
algorithm は木構造を決定するためのアルゴリズムを指定します。
以下の2つが利用可能です。
* "ORDEREDSUBJECT" subjectを使って平坦に区切るだけ
* "REFERENCES" どのメッセージに返事をしているかを見て木構造を作る
詳しくは 5256 を見てく... -
Net
:: IMAP # uid _ thread(algorithm , search _ keys , charset) -> [Net :: IMAP :: ThreadMember] (37507.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 :: ResponseError # response -> Net :: IMAP :: TaggedResponse | Net :: IMAP :: UntaggedResponse (37507.0) -
エラーとなったレスポンスを表すオブジェクトを返します。
エラーとなったレスポンスを表すオブジェクトを返します。 -
Net
:: IMAP # starttls(certs , verify) -> Net :: IMAP :: TaggedResponse (37207.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 . add _ authenticator(auth _ type , authenticator) -> () (37207.0) -
Net::IMAP#authenticate で使う 認証用クラスを設定します。
...追加するために用います。
通常は使う必要はないでしょう。もしこれを用いて
認証方式を追加する場合は net/imap.rb の
Net::IMAP::LoginAuthenticator などを参考にしてください。
@param auth_type 認証の種類(文字列)
@param authenticator 認... -
Net
:: IMAP # client _ thread -> Thread (36907.0) -
このメソッドは obsolete です。使わないでください。
このメソッドは obsolete です。使わないでください。 -
Net
:: IMAP # create(mailbox) -> Net :: IMAP :: TaggedResponse (36907.0) -
CREATE コマンドを送り、新しいメールボックスを作ります。
CREATE コマンドを送り、新しいメールボックスを作ります。
@param mailbox 新しいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスが作れなかった場合に発生します -
Net
:: IMAP # getquotaroot(mailbox) -> [Net :: IMAP :: MailboxQuotaRoot | Net :: IMAP :: MailboxQuota] (36907.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 (36907.0) -
サーバから最初に送られてくるメッセージ(greeting message) を返します。
サーバから最初に送られてくるメッセージ(greeting message)
を返します。 -
Net
:: IMAP # sort(sort _ keys , search _ keys , charset) -> [Integer] (36907.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(options) -> Net :: IMAP :: TaggedResponse (36907.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 # uid _ sort(sort _ keys , search _ keys , charset) -> [Integer] (36907.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 :: BodyTypeBasic # description -> String | nil (36907.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # description -> String | nil (36907.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeText # description -> String | nil (36907.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: Envelope # reply _ to -> [Net :: IMAP :: Address] | nil (36907.0) -
Reply-To を Net::IMAP::Address オブジェクトの配列で返します。
Reply-To を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: MailboxACLItem # rights -> String (36907.0) -
アクセス権限を文字列で返します。
アクセス権限を文字列で返します。
Net::IMAP::MailboxACLItem#user で得られるユーザが
持っている権限が返されます。
この文字列の意味については 2086 を参照してください。 -
Net
:: IMAP :: StatusData # attr -> { String => Integer } (36907.0) -
STATUS 応答の内容をハッシュで返します。
...STATUS 応答の内容をハッシュで返します。
ハッシュのキーは
"MESSAGES", "RECENT", "UIDNEXT", "UIDVALIDITY", "UNSEEN"
などが使われます。
詳しくは 2060 の 6.3.10、7.2.4 を見てください。... -
Net
:: IMAP :: ThreadMember # children -> [Net :: IMAP :: ThreadMember] (36907.0) -
スレッドの木構造における自身の下位の部分を返します。
スレッドの木構造における自身の下位の部分を返します。 -
Net
:: IMAP # client _ thread=(th) (36607.0) -
このメソッドは obsolete です。使わないでください。
このメソッドは obsolete です。使わないでください。 -
Net
:: IMAP # store(set , attr , flags) -> [Net :: IMAP :: FetchData] | nil (36607.0) -
STORE コマンドを送り、メールボックス内のメッセージを 更新します。
STORE コマンドを送り、メールボックス内のメッセージを
更新します。
set で更新するメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。
Net::IMAP#select で指定したメールボックスを対象とします。
attr で何をどのように変化させるかを指定します。
以下を指定することができます。
* "FLAGS"
* "+FLAGS"
* "-FLAGS"
それぞれメッセージのフラグの置き換え、追加、削除を意味します。
詳しくは 2060 の 6.4.6 を参考に... -
Net
:: IMAP # uid _ store(set , attr , flags) -> [Net :: IMAP :: FetchData] | nil (36607.0) -
UID STORE コマンドを送り、メールボックス内のメッセージを 更新します。
UID STORE コマンドを送り、メールボックス内のメッセージを
更新します。
set で更新するメッセージを指定します。
これには UID、UID の配列、もしくは
Range オブジェクトを渡します。
Net::IMAP#select で指定したメールボックスを対象とします。
attr で何をどのように変化させるかを指定します。
以下を指定することができます。
* "FLAGS"
* "+FLAGS"
* "-FLAGS"
それぞれメッセージのフラグの置き換え、追加、削除を意味します。
詳しくは 2060 の 6.4.6 を参考にしてください。
返り値は更新された内... -
Net
:: IMAP . default _ imap _ port -> Integer (36607.0) -
デフォルトの IMAP のポート番号(143)を返します。
デフォルトの IMAP のポート番号(143)を返します。
@see Net::IMAP.default_tls_port -
Net
:: IMAP . default _ imaps _ port -> Integer (36607.0) -
デフォルトの IMAPS のポート番号(993)を返します。
デフォルトの IMAPS のポート番号(993)を返します。
@see Net::IMAP.default_port -
Net
:: IMAP . default _ port -> Integer (36607.0) -
デフォルトの IMAP のポート番号(143)を返します。
デフォルトの IMAP のポート番号(143)を返します。
@see Net::IMAP.default_tls_port -
Net
:: IMAP . default _ ssl _ port -> Integer (36607.0) -
デフォルトの IMAPS のポート番号(993)を返します。
デフォルトの IMAPS のポート番号(993)を返します。
@see Net::IMAP.default_port -
Net
:: IMAP . default _ tls _ port -> Integer (36607.0) -
デフォルトの IMAPS のポート番号(993)を返します。
デフォルトの IMAPS のポート番号(993)を返します。
@see Net::IMAP.default_port -
Net
:: IMAP . format _ date(time) -> String (36607.0) -
時刻オブジェクトを IMAP の日付フォーマットでの文字列に変換します。
...時刻オブジェクトを IMAP の日付フォーマットでの文字列に変換します。
require 'net/imap'
Net::IMAP.format_date(Time.new(2011, 6, 20))
# => "20-Jun-2011"
@param time 変換する時刻オブジェクト... -
Net
:: IMAP . format _ datetime(time) -> String (36607.0) -
時刻オブジェクトを IMAP の日付時刻フォーマットでの文字列に変換します
...時刻オブジェクトを IMAP の日付時刻フォーマットでの文字列に変換します
require 'net/imap'
Net::IMAP.format_datetime(Time.new(2011, 6, 20, 13, 20, 1))
# => "20-Jun-2011 13:20 +0900"
@param time 変換する時刻オブジェクト... -
Net
:: IMAP :: Address # route -> String | nil (36607.0) -
メールアドレスの SMTP at-domain-list を返します。
メールアドレスの SMTP at-domain-list を返します。
存在しない場合は nil を返します。
通常は nil を返します。 -
Net
:: IMAP :: BodyTypeBasic # multipart? -> bool (36607.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: BodyTypeMessage # multipart? -> bool (36607.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: BodyTypeText # multipart? -> bool (36607.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: ContinuationRequest # raw _ data -> String (36607.0) -
レスポンス文字列を返します。
レスポンス文字列を返します。 -
Net
:: IMAP :: DRAFT -> Symbol (36607.0) -
「:Draft」というシンボルを返します。
「:Draft」というシンボルを返します。
メッセージが草稿であることを意味します。
フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: Envelope # in _ reply _ to -> String | nil (36607.0) -
In-reply-to の内容を文字列で返します。
In-reply-to の内容を文字列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: FetchData # attr -> { String => object } (36607.0) -
各メッセージのアトリビュートの値をハッシュテーブルで返します。
各メッセージのアトリビュートの値をハッシュテーブルで返します。
キーはアトリビュート名の文字列、値はアトリビュートの値となります。
値のクラスはアトリビュートによって異なります。
利用可能なアトリビュートは以下の通りです。
: BODY
BODYSTRUCTURE の拡張データなしの形式。
Net::IMAP::BodyTypeBasic, Net::IMAP::BodyTypeText,
Net::IMAP::BodyTypeMessage, Net::IMAP::BodyTypeMultipart
のいずれか。
: BODY[<section>]<<... -
Net
:: IMAP :: MailboxList # attr -> [Symbol] (36607.0) -
メールボックスの属性をシンボルの配列で返します。
メールボックスの属性をシンボルの配列で返します。
これで得られるシンボルは String#capitalize でキャピタライズ
されています。
この配列には例えば以下のような値を含んでいます。
詳しくは 2060 7.2.2 などを参照してください。
以下のもの以外で、IMAP 関連 RFC で拡張された値を含んでいる
場合もあります
* :Noselect
* :Noinferiors
* :Marked
* :Unmarked -
Net
:: IMAP :: RECENT -> Symbol (36607.0) -
「:Recent」というシンボルを返します。
「:Recent」というシンボルを返します。
メッセージが「最近」メールボックスに到着したことを意味します。
フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: ResponseError # response=(resp) (36607.0) -
エラーとなったレスポンスを表すオブジェクトを設定します。
エラーとなったレスポンスを表すオブジェクトを設定します。
@param resp 設定するレスポンスオブジェクト -
Net
:: IMAP :: TaggedResponse # raw _ data -> String (36607.0) -
レスポンス文字列を返します。
レスポンス文字列を返します。
@see Net::IMAP::TaggedResponse#data -
Net
:: IMAP :: UntaggedResponse # raw _ data -> String (36607.0) -
レスポンス文字列を返します。
レスポンス文字列を返します。
@see Net::IMAP::UntaggedResponse#data -
Net
:: IMAP :: BodyTypeMultipart (36007.0) -
マルチパートなメッセージを表すクラスです。
マルチパートなメッセージを表すクラスです。
詳しくは MIME のRFC(2045)を参照してください。 -
Net
:: IMAP :: DataFormatError (36007.0) -
データフォーマットが正しくない場合に発生する例外のクラスです。
データフォーマットが正しくない場合に発生する例外のクラスです。 -
Net
:: IMAP :: FlagCountError (36007.0) -
サーバからのレスポンスに含まれるフラグが多すぎるときに発生する例外です。
サーバからのレスポンスに含まれるフラグが多すぎるときに発生する例外です。
この上限は Net::IMAP.max_flag_count= で設定します。 -
Net
:: IMAP :: MailboxQuotaRoot (36007.0) -
Net::IMAP#getquotaroot の結果として得られる quota root 情報を表わすオブジェクトです。
Net::IMAP#getquotaroot の結果として得られる
quota root 情報を表わすオブジェクトです。
詳しくは 2087 を参照してください。 -
Net
:: IMAP :: ResponseText (36007.0) -
応答のテキストを表すクラスです。
応答のテキストを表すクラスです。 -
Net
:: IMAP :: TaggedResponse (36007.0) -
IMAP のタグ付きレスポンスを表すクラスです。
IMAP のタグ付きレスポンスを表すクラスです。
IMAP のレスポンスにはタグ付きのものとタグなしのものがあり、
タグ付きのレスポンスはクライアントが発行したコマンドによる
操作が成功するか失敗するかのどちらかで
完了したことを意味します。タグによって
どのコマンドが完了したのかを示します。
@see Net::IMAP::UntaggedResponse -
Net
:: IMAP :: ThreadMember (36007.0) -
Net::IMAP#thread、 Net::IMAP#uid_thread から 得られるスレッドの木構造のノードを表すクラスです。
Net::IMAP#thread、 Net::IMAP#uid_thread から
得られるスレッドの木構造のノードを表すクラスです。 -
Net
:: IMAP :: UntaggedResponse (36007.0) -
IMAP のタグ付きレスポンスを表すクラスです。
IMAP のタグ付きレスポンスを表すクラスです。
IMAP のレスポンスにはタグ付きのものとタグなしのものがあり、
タグなしのものはクライアントからのコマンド完了応答ではない
レスポンスです。
@see Net::IMAP::TaggedResponse -
Net
:: IMAP # rename(mailbox , newname) -> Net :: IMAP :: TaggedResponse (27907.0) -
RENAME コマンドを送り、指定したメールボックスをリネームします。
RENAME コマンドを送り、指定したメールボックスをリネームします。
@param mailbox リネームするメールボックス(文字列)
@param newname リネーム後の名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
リネームできなかった場合に発生します。
指定した名前のメールボックスが存在しない場合や、
リネーム後の名前を持つメールボックスが既に存在する
場合に発生します。 -
Net
:: IMAP :: BodyTypeBasic # param -> { String => String } | nil (27907.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # param -> { String => String } | nil (27907.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: BodyTypeMultipart # param -> { String => String } (27907.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: BodyTypeText # param -> { String => String } | nil (27907.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: ContentDisposition # param -> { String => String } | nil (27907.0) -
Content-Disposition フィールドのパラメータをハッシュテーブルで 返します。
Content-Disposition フィールドのパラメータをハッシュテーブルで
返します。
ハッシュテーブルのキーは以下のような値を取ります。詳しくは
2183 などを見てください。
* "FILENAME"
* "CREATION-DATE"
* "MODIFICATION-DATE"
* "READ-DAT"
* "SIZE" -
Net
:: IMAP # add _ response _ handler(handler) {|resp| . . . } -> () (27607.0) -
レスポンスハンドラを追加します。
レスポンスハンドラを追加します。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。
レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_respo... -
Net
:: IMAP # responses -> { String => [object] } (27607.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] (27607.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 # subscribe(mailbox) -> Net :: IMAP :: TaggedResponse (27607.0) -
SUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合に 追加します。
SUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合に
追加します。
@param mailbox 追加するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
追加できなかった場合に発生します。
指定した名前のメールボックスが存在しない場合などに
生じます。 -
Net
:: IMAP # uid _ search(keys , charset = nil) -> [Integer] (27607.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 # unsubscribe(mailbox) -> Net :: IMAP :: TaggedResponse (27607.0) -
UNSUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合から 削除します。
UNSUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合から
削除します。
@param mailbox 削除するするメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
削除できなかった場合に発生します。
指定した名前のメールボックスが active/subscribe でなかった
場合などに発生します。 -
Net
:: IMAP :: Address # host -> String | nil (27607.0) -
メールアドレスのホスト名を返します。
メールアドレスのホスト名を返します。
nil は 822 のグループ文法に対応します。
これについては Net::IMAP::Address#mailbox も参照してください。
そうでない場合は 822 のドメイン名を表します。
通常は、メールアドレスの「@」の後ろのドメイン名を返します。 -
Net
:: IMAP :: BodyTypeMultipart # disposition -> Net :: IMAP :: ContentDisposition | nil (27607.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMultipart # extension -> Array | nil (27607.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeMultipart # media _ subtype -> String (27607.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see 2045, Net::IMAP::BodyTypeText#media_type -
Net
:: IMAP :: BodyTypeMultipart # media _ type -> String (27607.0) -
MIME のメディアタイプを返します。
MIME のメディアタイプを返します。
"MULTIPART" を返します。
@see Net::IMAP::BodyTypeMultipart#subtype -
Net
:: IMAP :: BodyTypeMultipart # subtype -> String (27607.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see 2045, Net::IMAP::BodyTypeText#media_type -
Net
:: IMAP :: ContinuationRequest # data -> Net :: IMAP :: ResponseText (27607.0) -
レスポンスのデータを返します。
レスポンスのデータを返します。 -
Net
:: IMAP :: Envelope # from -> [Net :: IMAP :: Address] | nil (27607.0) -
From を Net::IMAP::Address オブジェクトの配列で返します。
From を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # sender -> [Net :: IMAP :: Address] | nil (27607.0) -
Sender を Net::IMAP::Address オブジェクトの配列で返します。
Sender を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: MailboxACLItem # user -> String (27607.0) -
ユーザ名を返します。
ユーザ名を返します。
このユーザは
Net::IMAP#getacl で指定したメールボックスに
対し何らかの権限を持っています。 -
Net
:: IMAP :: ResponseText # text -> String (27607.0) -
応答のテキストを文字列で返します。
応答のテキストを文字列で返します。 -
Net
:: IMAP :: TaggedResponse # data -> Net :: IMAP :: ResponseText (27607.0) -
レスポンスを解析したオブジェクトを返します。
レスポンスを解析したオブジェクトを返します。
@see Net::IMAP::ResponseText -
Net
:: IMAP :: TaggedResponse # tag -> String (27607.0) -
レスポンスに対応付けられたタグを返します。
レスポンスに対応付けられたタグを返します。 -
Net
:: IMAP # add _ response _ handler(handler) -> () (27307.0) -
レスポンスハンドラを追加します。
レスポンスハンドラを追加します。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。
レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_respo... -
Net
:: IMAP # response _ handlers -> Array (27307.0) -
設定されているレスポンスハンドラ全てを 配列で返します。
設定されているレスポンスハンドラ全てを
配列で返します。
@see Net::IMAP#add_response_handler -
Net
:: IMAP :: ANSWERED -> Symbol (27307.0) -
「:Answered」というシンボルを返します。
「:Answered」というシンボルを返します。
そのメッセージに返答したことを意味します。
フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: MARKED -> Symbol (27307.0) -
「:Marked」というシンボルを返します。
「:Marked」というシンボルを返します。
メールボックスが「interesting」であるとサーバによって
印付けられていることを意味します。通常メールボックスに
新しいメールが届いていることを意味します。
LIST応答の属性
(Net::IMAP#list、Net::IMAP::MailboxList#attr)
として用いられます。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: NOINFERIORS -> Symbol (27307.0) -
「:Noinferiors」というシンボルを返します。
「:Noinferiors」というシンボルを返します。
このメールボックスの
下に子レベルの階層が存在不可能であることを意味します。
LIST応答の属性
(Net::IMAP#list、Net::IMAP::MailboxList#attr)
として用いられます。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: ResponseCode # data -> object | nil (27307.0) -
レスポンスコードのデータを返します。
レスポンスコードのデータを返します。
レスポンスコードの種類によって返すオブジェクトは異なります。
ない場合は nil を返します。 -
Net
:: IMAP :: UNMARKED -> Symbol (27307.0) -
「:Unmarked」というシンボルを返します。
「:Unmarked」というシンボルを返します。
メールボックスが
印付けられていないことを意味します。
メールボックスに新しいメールが届いていないことを意味します。
LIST応答の属性
(Net::IMAP#list、Net::IMAP::MailboxList#attr)
として用いられます。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: UntaggedResponse # data -> object (27307.0) -
レスポンスを解析した結果のオブジェクトを返します。
レスポンスを解析した結果のオブジェクトを返します。
レスポンスによって異なるオブジェクトを返します。
Net::IMAP::MailboxList であったりフラグを表わす
シンボルの配列であったりします。 -
Net
:: IMAP :: Address (27007.0) -
メールアドレスを表すクラスです。
メールアドレスを表すクラスです。 -
Net
:: IMAP :: BadResponseError (27007.0) -
サーバから "BAD" レスポンスが来た場合に発生する例外のクラスです。 クライアントからのコマンドが IMAP の規格から外れている場合や サーバ内部エラーの場合に発生します。
サーバから "BAD" レスポンスが来た場合に発生する例外のクラスです。
クライアントからのコマンドが IMAP の規格から外れている場合や
サーバ内部エラーの場合に発生します。 -
Net
:: IMAP :: ByeResponseError (27007.0) -
サーバから "BYE" レスポンスが来た場合に発生する例外のクラスです。 ログインが拒否された場合や、クライアントが無反応で タイムアウトした場合に発生します。
サーバから "BYE" レスポンスが来た場合に発生する例外のクラスです。
ログインが拒否された場合や、クライアントが無反応で
タイムアウトした場合に発生します。 -
Net
:: IMAP :: Error (27007.0) -
すべての IMAP 例外クラスのスーパークラス。
すべての IMAP 例外クラスのスーパークラス。 -
Net
:: IMAP :: NoResponseError (27007.0) -
サーバから "NO" レスポンスが来た場合に発生する例外のクラスです。 コマンドが正常に完了しなかった場合に発生します。
サーバから "NO" レスポンスが来た場合に発生する例外のクラスです。
コマンドが正常に完了しなかった場合に発生します。 -
Net
:: IMAP :: ResponseCode (27007.0) -
応答のレスポンスコードを表すクラスです。
応答のレスポンスコードを表すクラスです。
レスポンスコードについては 2060 の 7.1 を参照してください。 -
Net
:: IMAP :: ResponseError (27007.0) -
サーバからのレスポンスがエラーを示している場合に発生する例外 のクラスです。
サーバからのレスポンスがエラーを示している場合に発生する例外
のクラスです。
実際にはこれを継承した
* Net::IMAP::NoResponseError
* Net::IMAP::BadResponseError
* Net::IMAP::ByeResponseError
これらのクラスの例外が発生します。 -
Net
:: IMAP :: ResponseParseError (27007.0) -
サーバからのレスポンスが正しくパースできない場合に発生する 例外のクラスです。
サーバからのレスポンスが正しくパースできない場合に発生する
例外のクラスです。 -
Net
:: IMAP :: BodyTypeMultipart # language -> String | [String] | nil (19207.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP # fetch(set , attr) -> [Net :: IMAP :: FetchData] (18943.0) -
FETCH コマンドを送り、メールボックス内のメッセージに 関するデータを取得します。
FETCH コマンドを送り、メールボックス内のメッセージに
関するデータを取得します。
Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを対象とします。
set で対象とするメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。
attr には取得するアトリビュートを文字列の配列で渡してください。
指定可能なアトリビュートについては Net::IMAP::FetchData#attr
を見てください。
例:
p imap.... -
Net
:: IMAP # authenticate(auth _ type , user , password) -> Net :: IMAP :: TaggedResponse (18907.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 # uid _ fetch(set , attr) -> [Net :: IMAP :: FetchData] (18907.0) -
UID FETCH コマンドを送り、メールボックス内のメッセージに 関するデータを取得します。
UID FETCH コマンドを送り、メールボックス内のメッセージに
関するデータを取得します。
Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを対象とします。
set で対象とするメッセージを指定します。
これには UID、UID の配列、もしくは
Range オブジェクトを渡します。
attr には取得するアトリビュートを文字列の配列で渡してください。
指定可能なアトリビュートについては Net::IMAP::FetchData#attr
を見てください。
@param set 処理対象のメッセージの UID
@param...