ライブラリ
-
net
/ imap (206)
クラス
-
Net
:: IMAP (79) -
Net
:: IMAP :: Address (4) -
Net
:: IMAP :: BodyTypeBasic (13) -
Net
:: IMAP :: BodyTypeMessage (16) -
Net
:: IMAP :: BodyTypeMultipart (9) -
Net
:: IMAP :: BodyTypeText (14) -
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)
- BodyTypeBasic (1)
- BodyTypeMessage (1)
- BodyTypeMultipart (1)
- BodyTypeText (1)
- ByeResponseError (1)
- ContentDisposition (1)
- ContinuationRequest (1)
- DELETED (1)
- DRAFT (1)
- DataFormatError (1)
- Envelope (1)
- Error (1)
- FLAGGED (1)
- FetchData (1)
- FlagCountError (1)
- IMAP (1)
- MARKED (1)
- MailboxACLItem (1)
- MailboxList (1)
- MailboxQuota (1)
- MailboxQuotaRoot (1)
-
NEWS for Ruby 2
. 0 . 0 (1) - NOINFERIORS (1)
- NOSELECT (1)
- NoResponseError (1)
- RECENT (1)
- ResponseCode (1)
- ResponseError (1)
- ResponseParseError (1)
- ResponseText (1)
- SEEN (1)
- StatusData (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)
- debug (1)
- debug= (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)
- disconnect (1)
- disconnected? (1)
- disposition (4)
-
dsp
_ type (1) -
encode
_ utf7 (1) - encoding (3)
- envelope (1)
- examine (1)
- expunge (1)
- extension (4)
- fetch (1)
-
format
_ date (1) -
format
_ datetime (1) - from (1)
- getacl (1)
- getquota (1)
- getquotaroot (1)
- greeting (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)
-
max
_ flag _ count (1) -
max
_ flag _ count= (1) - md5 (3)
-
media
_ subtype (4) -
media
_ type (4) - move (1)
- multipart? (4)
- name (5)
- new (2)
- 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)
-
ruby 1
. 8 . 2 feature (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 (132055.0) -
このライブラリは Internet Message Access Protocol (IMAP) の クライアントライブラリです。2060 を元に 実装されています。
このライブラリは Internet Message Access Protocol (IMAP) の
クライアントライブラリです。2060 を元に
実装されています。
=== IMAP の概要
IMAPを利用するには、まずサーバに接続し、
Net::IMAP#authenticate もしくは
Net::IMAP#login で認証します。
IMAP ではメールボックスという概念が重要です。
メールボックスは階層的な名前を持ちます。
各メールボックスはメールを保持することができます。
メールボックスの実装はサーバソフトウェアによって異なります。
Unixシステムでは、ディレクトリ階層上の
... -
Net
:: IMAP . format _ date(time) -> String (51619.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 (51619.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 # append(mailbox , message , flags = nil , date _ time = nil) -> Net :: IMAP :: TaggedResponse (51601.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 # capability -> [String] (51301.0) -
CAPABILITY コマンドを送ってサーバがサポートしている 機能(capabilities)のリストを文字列の配列として返します。
CAPABILITY コマンドを送ってサーバがサポートしている
機能(capabilities)のリストを文字列の配列として返します。
capability は IMAP に関連する RFC などで定義されています。
imap.capability
# => ["IMAP4REV1", "UNSELECT", "IDLE", "NAMESPACE", "QUOTA", ... ] -
Net
:: IMAP . default _ imap _ port -> Integer (51301.0) -
デフォルトの IMAP のポート番号(143)を返します。
デフォルトの IMAP のポート番号(143)を返します。
@see Net::IMAP.default_tls_port -
Net
:: IMAP . default _ imaps _ port -> Integer (51301.0) -
デフォルトの IMAPS のポート番号(993)を返します。
デフォルトの IMAPS のポート番号(993)を返します。
@see Net::IMAP.default_port -
Net
:: IMAP . default _ port -> Integer (51301.0) -
デフォルトの IMAP のポート番号(143)を返します。
デフォルトの IMAP のポート番号(143)を返します。
@see Net::IMAP.default_tls_port -
Net
:: IMAP . default _ ssl _ port -> Integer (51301.0) -
デフォルトの IMAPS のポート番号(993)を返します。
デフォルトの IMAPS のポート番号(993)を返します。
@see Net::IMAP.default_port -
Net
:: IMAP . default _ tls _ port -> Integer (51301.0) -
デフォルトの IMAPS のポート番号(993)を返します。
デフォルトの IMAPS のポート番号(993)を返します。
@see Net::IMAP.default_port -
Net
:: IMAP :: DataFormatError (51001.0) -
データフォーマットが正しくない場合に発生する例外のクラスです。
データフォーマットが正しくない場合に発生する例外のクラスです。 -
Net
:: IMAP :: StatusData (51001.0) -
STATUS 応答を表わすクラスです。
STATUS 応答を表わすクラスです。 -
Net
:: IMAP # authenticate(auth _ type , user , password) -> Net :: IMAP :: TaggedResponse (42601.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 # client _ thread -> Thread (42601.0) -
このメソッドは obsolete です。使わないでください。
このメソッドは obsolete です。使わないでください。 -
Net
:: IMAP # getacl(mailbox) -> [Net :: IMAP :: MailboxACLItem] (42601.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 # getquotaroot(mailbox) -> [Net :: IMAP :: MailboxQuotaRoot | Net :: IMAP :: MailboxQuota] (42601.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 # remove _ response _ handler(handler) -> () (42601.0) -
レスポンスハンドラを削除します。
レスポンスハンドラを削除します。
@param handler 削除するハンドラ
@see Net::IMAP#add_response_handler -
Net
:: IMAP # rename(mailbox , newname) -> Net :: IMAP :: TaggedResponse (42601.0) -
RENAME コマンドを送り、指定したメールボックスをリネームします。
RENAME コマンドを送り、指定したメールボックスをリネームします。
@param mailbox リネームするメールボックス(文字列)
@param newname リネーム後の名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
リネームできなかった場合に発生します。
指定した名前のメールボックスが存在しない場合や、
リネーム後の名前を持つメールボックスが既に存在する
場合に発生します。 -
Net
:: IMAP # search(keys , charset = nil) -> [Integer] (42601.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 # status(mailbox , attr) -> {String => Integer} (42601.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 # thread(algorithm , search _ keys , charset) -> [Net :: IMAP :: ThreadMember] (42601.0) -
THREADコマンドを送り、メールボックスを検索した結果を スレッド形式の木構造で返します。
THREADコマンドを送り、メールボックスを検索した結果を
スレッド形式の木構造で返します。
THREAD コマンドは 5256 で定義されています。
詳しくはそちらを参照してください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
algorithm は木構造を決定するためのアルゴリズムを指定します。
以下の2つが利用可能です。
* "ORDEREDSUBJECT" subjectを使って平坦に区切るだけ
* "REFERENCES" どのメッセージに返事をしているかを見て木構造を作る
詳しくは 5256 を見てく... -
Net
:: IMAP # uid _ search(keys , charset = nil) -> [Integer] (42601.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 _ thread(algorithm , search _ keys , charset) -> [Net :: IMAP :: ThreadMember] (42601.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 :: BodyTypeMultipart # parts -> [Net :: IMAP :: BodyTypeBasic | Net :: IMAP :: BodyTypeText | Net :: IMAP :: BodyTypeMessage | Net :: IMAP :: BodyTypeMultipart] (42601.0) -
マルチパートの各部分を返します。
マルチパートの各部分を返します。 -
Net
:: IMAP . add _ authenticator(auth _ type , authenticator) -> () (42319.0) -
Net::IMAP#authenticate で使う 認証用クラスを設定します。
Net::IMAP#authenticate で使う
認証用クラスを設定します。
imap ライブラリに新たな認証方式を追加するために用います。
通常は使う必要はないでしょう。もしこれを用いて
認証方式を追加する場合は net/imap.rb の
Net::IMAP::LoginAuthenticator などを参考にしてください。
@param auth_type 認証の種類(文字列)
@param authenticator 認証クラス(Class オブジェクト) -
Net
:: IMAP # add _ response _ handler(handler) -> () (42301.0) -
レスポンスハンドラを追加します。
レスポンスハンドラを追加します。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。
レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_respo... -
Net
:: IMAP # add _ response _ handler(handler) {|resp| . . . } -> () (42301.0) -
レスポンスハンドラを追加します。
レスポンスハンドラを追加します。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。
レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_respo... -
Net
:: IMAP # client _ thread=(th) (42301.0) -
このメソッドは obsolete です。使わないでください。
このメソッドは obsolete です。使わないでください。 -
Net
:: IMAP # create(mailbox) -> Net :: IMAP :: TaggedResponse (42301.0) -
CREATE コマンドを送り、新しいメールボックスを作ります。
CREATE コマンドを送り、新しいメールボックスを作ります。
@param mailbox 新しいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスが作れなかった場合に発生します -
Net
:: IMAP # examine(mailbox) -> Net :: IMAP :: TaggedResponse (42301.0) -
EXAMINE コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。
EXAMINE コマンドを送り、指定したメールボックスを処理対象の
メールボックスにします。
Net::IMAP#select と異なりセッション中はメールボックスが
読み取り専用となります。それ以外は select と同じです。
@param mailbox 処理対象としたいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError mailboxが存在しない等の理由でコマンドの実行に失敗
した場合に発生します。 -
Net
:: IMAP # getquota(mailbox) -> [Net :: IMAP :: MailboxQuota] (42301.0) -
GETQUOTA コマンドを送って 指定したメールボックスの quota の情報を返します。
GETQUOTA コマンドを送って
指定したメールボックスの quota の情報を返します。
quota の情報は Net::IMAP::MailboxQuota オブジェクトの配列で
得られます。
詳しくは 2087 を見てください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
@param mailbox quota 情報を得たいメールボックス名
@raise Net::IMAP::NoResponseError 指定したメールボックスが quota root でない場合に発生します -
Net
:: IMAP # response _ handlers -> Array (42301.0) -
設定されているレスポンスハンドラ全てを 配列で返します。
設定されているレスポンスハンドラ全てを
配列で返します。
@see Net::IMAP#add_response_handler -
Net
:: IMAP # setacl(mailbox , user , rights) (42301.0) -
SETACL コマンドを送り、指定したメールボックスに 指定したユーザに関する権限を設定します。
SETACL コマンドを送り、指定したメールボックスに
指定したユーザに関する権限を設定します。
rights には設定する権限を表す文字列を指定します。
どのような文字列を指定すべきかは 2086 を参照してください。
rights に nil を渡すと、空文字列を指定したのと同様、つまり
すべての権限を削除します。
@param mailbox 権限を設定するメールボックスの名前(文字列)
@param user 権限を設定するユーザの名前(文字列)
@param rights 権限を表す文字列 -
Net
:: IMAP # setquota(mailbox , quota) -> Net :: IMAP :: TaggedResponse (42301.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 # starttls(certs , verify) -> Net :: IMAP :: TaggedResponse (42301.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 (42301.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 . max _ flag _ count -> Integer (42301.0) -
サーバからのレスポンスに含まれる flag の上限を返します。
サーバからのレスポンスに含まれる flag の上限を返します。
これを越えた flag がレスポンスに含まれている場合は、
Net::IMAP::FlagCountError 例外が発生します。
@see Net::IMAP.max_flag_count= -
Net
:: IMAP . max _ flag _ count=(count) (42301.0) -
サーバからのレスポンスに含まれる flag の上限を設定します。
サーバからのレスポンスに含まれる flag の上限を設定します。
これを越えた flag がレスポンスに含まれている場合は、
Net::IMAP::FlagCountError 例外が発生します。
デフォルトは 10000 です。通常は変える必要はないでしょう。
@param count 設定する最大値の整数
@see Net::IMAP.max_flag_count -
Net
:: IMAP :: ANSWERED -> Symbol (42301.0) -
「:Answered」というシンボルを返します。
「:Answered」というシンボルを返します。
そのメッセージに返答したことを意味します。
フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: Address # mailbox -> String | nil (42301.0) -
メールアドレスのメールボックス名を返します。
メールアドレスのメールボックス名を返します。
これが nil ならばそれは 822 group の終わりを意味します。
これが nil でなく、Net::IMAP::Address#mailbox が nil ならば、
822 のグループ名を表します。
どれでもなければ、822 の local-part を表します。
通常は、メールアドレスの「@」の手前を返します。 -
Net
:: IMAP :: Address # name -> String | nil (42301.0) -
メールアドレスの 822 の個人名(personal name)を返します。
メールアドレスの 822 の個人名(personal name)を返します。
個人名が存在しない場合は nil を返します。
通常は nil を返します。 -
Net
:: IMAP :: BodyTypeBasic # language -> String | [String] | nil (42301.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeBasic # media _ subtype -> String (42301.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeBasic#media_type -
Net
:: IMAP :: BodyTypeBasic # media _ type -> String (42301.0) -
MIME のメディアタイプを返します。
MIME のメディアタイプを返します。
@see Net::IMAP::BodyTypeBasic#subtype -
Net
:: IMAP :: BodyTypeBasic # multipart? -> bool (42301.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: BodyTypeBasic # param -> { String => String } | nil (42301.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # language -> String | [String] | nil (42301.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeMessage # media _ subtype -> String (42301.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeMessage#media_type -
Net
:: IMAP :: BodyTypeMessage # media _ type -> String (42301.0) -
MIME のメディアタイプを返します。
MIME のメディアタイプを返します。
これは "MESSAGE" を返します。
@see Net::IMAP::BodyTypeMessage#subtype -
Net
:: IMAP :: BodyTypeMessage # multipart? -> bool (42301.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: BodyTypeMessage # param -> { String => String } | nil (42301.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: BodyTypeMultipart # language -> String | [String] | nil (42301.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeMultipart # media _ subtype -> String (42301.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see 2045, Net::IMAP::BodyTypeText#media_type -
Net
:: IMAP :: BodyTypeMultipart # media _ type -> String (42301.0) -
MIME のメディアタイプを返します。
MIME のメディアタイプを返します。
"MULTIPART" を返します。
@see Net::IMAP::BodyTypeMultipart#subtype -
Net
:: IMAP :: BodyTypeMultipart # multipart? -> bool (42301.0) -
マルチパートかどうかを返します。 true を返します。
マルチパートかどうかを返します。
true を返します。 -
Net
:: IMAP :: BodyTypeMultipart # param -> { String => String } (42301.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: BodyTypeText # language -> String | [String] | nil (42301.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeText # media _ subtype -> String (42301.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeText#media_type -
Net
:: IMAP :: BodyTypeText # media _ type -> String (42301.0) -
MIME のメディアタイプを返します。
MIME のメディアタイプを返します。
これは "TEXT" を返します。
@see Net::IMAP::BodyTypeText#subtype -
Net
:: IMAP :: BodyTypeText # multipart? -> bool (42301.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: BodyTypeText # param -> { String => String } | nil (42301.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: ContentDisposition # param -> { String => String } | nil (42301.0) -
Content-Disposition フィールドのパラメータをハッシュテーブルで 返します。
Content-Disposition フィールドのパラメータをハッシュテーブルで
返します。
ハッシュテーブルのキーは以下のような値を取ります。詳しくは
2183 などを見てください。
* "FILENAME"
* "CREATION-DATE"
* "MODIFICATION-DATE"
* "READ-DAT"
* "SIZE" -
Net
:: IMAP :: ContinuationRequest # data -> Net :: IMAP :: ResponseText (42301.0) -
レスポンスのデータを返します。
レスポンスのデータを返します。 -
Net
:: IMAP :: ContinuationRequest # raw _ data -> String (42301.0) -
レスポンス文字列を返します。
レスポンス文字列を返します。 -
Net
:: IMAP :: DRAFT -> Symbol (42301.0) -
「:Draft」というシンボルを返します。
「:Draft」というシンボルを返します。
メッセージが草稿であることを意味します。
フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: Envelope # date -> String | nil (42301.0) -
日付の文字列を返します。
日付の文字列を返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # message _ id -> String | nil (42301.0) -
message_id を文字列で返します。
message_id を文字列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: FLAGGED -> Symbol (42301.0) -
「:Flagged」というシンボルを返します。
「:Flagged」というシンボルを返します。
そのメッセージに特別なフラグを立てていることを意味します。
フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: FetchData # attr -> { String => object } (42301.0) -
各メッセージのアトリビュートの値をハッシュテーブルで返します。
各メッセージのアトリビュートの値をハッシュテーブルで返します。
キーはアトリビュート名の文字列、値はアトリビュートの値となります。
値のクラスはアトリビュートによって異なります。
利用可能なアトリビュートは以下の通りです。
: BODY
BODYSTRUCTURE の拡張データなしの形式。
Net::IMAP::BodyTypeBasic, Net::IMAP::BodyTypeText,
Net::IMAP::BodyTypeMessage, Net::IMAP::BodyTypeMultipart
のいずれか。
: BODY[<section>]<<... -
Net
:: IMAP :: MARKED -> Symbol (42301.0) -
「:Marked」というシンボルを返します。
「:Marked」というシンボルを返します。
メールボックスが「interesting」であるとサーバによって
印付けられていることを意味します。通常メールボックスに
新しいメールが届いていることを意味します。
LIST応答の属性
(Net::IMAP#list、Net::IMAP::MailboxList#attr)
として用いられます。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: MailboxList # attr -> [Symbol] (42301.0) -
メールボックスの属性をシンボルの配列で返します。
メールボックスの属性をシンボルの配列で返します。
これで得られるシンボルは String#capitalize でキャピタライズ
されています。
この配列には例えば以下のような値を含んでいます。
詳しくは 2060 7.2.2 などを参照してください。
以下のもの以外で、IMAP 関連 RFC で拡張された値を含んでいる
場合もあります
* :Noselect
* :Noinferiors
* :Marked
* :Unmarked -
Net
:: IMAP :: MailboxList # name -> String (42301.0) -
メールボックスの名前を文字列で返します。
メールボックスの名前を文字列で返します。 -
Net
:: IMAP :: MailboxQuota # mailbox -> String (42301.0) -
quota が設定されているメールボックスの名前を返します。
quota が設定されているメールボックスの名前を返します。 -
Net
:: IMAP :: MailboxQuota # quota -> Integer (42301.0) -
メールボックスに指定されている上限値を返します。
メールボックスに指定されている上限値を返します。 -
Net
:: IMAP :: MailboxQuota # usage -> Integer (42301.0) -
現在のメールボックス内の使用量を返します。
現在のメールボックス内の使用量を返します。 -
Net
:: IMAP :: MailboxQuotaRoot # mailbox -> String (42301.0) -
問い合わせしたメールボックスの名前を返します。
問い合わせしたメールボックスの名前を返します。 -
Net
:: IMAP :: MailboxQuotaRoot # quotaroots -> [String] (42301.0) -
問い合わせしたメールボックスの quota root 名を配列で返します。
問い合わせしたメールボックスの quota root 名を配列で返します。
空の場合もありえます。 -
Net
:: IMAP :: ResponseCode # data -> object | nil (42301.0) -
レスポンスコードのデータを返します。
レスポンスコードのデータを返します。
レスポンスコードの種類によって返すオブジェクトは異なります。
ない場合は nil を返します。 -
Net
:: IMAP :: ResponseCode # name -> String (42301.0) -
レスポンスコードを表す文字列を返します。 "ALERT"、"PERMANENTFLAGS"、"UIDVALIDITY" などを返します。
レスポンスコードを表す文字列を返します。
"ALERT"、"PERMANENTFLAGS"、"UIDVALIDITY" などを返します。 -
Net
:: IMAP :: StatusData # attr -> { String => Integer } (42301.0) -
STATUS 応答の内容をハッシュで返します。
STATUS 応答の内容をハッシュで返します。
ハッシュのキーは
"MESSAGES", "RECENT", "UIDNEXT", "UIDVALIDITY", "UNSEEN"
などが使われます。
詳しくは 2060 の 6.3.10、7.2.4 を見てください。 -
Net
:: IMAP :: StatusData # mailbox -> String (42301.0) -
メールボックス名を返します。
メールボックス名を返します。 -
Net
:: IMAP :: TaggedResponse # data -> Net :: IMAP :: ResponseText (42301.0) -
レスポンスを解析したオブジェクトを返します。
レスポンスを解析したオブジェクトを返します。
@see Net::IMAP::ResponseText -
Net
:: IMAP :: TaggedResponse # name -> String (42301.0) -
レスポンスの名前(種類)を返します。
レスポンスの名前(種類)を返します。
例えば以下のような値を返します。これらの具体的な意味は
2060 を参考にしてください。
* "OK"
* "NO"
* "BAD" -
Net
:: IMAP :: TaggedResponse # raw _ data -> String (42301.0) -
レスポンス文字列を返します。
レスポンス文字列を返します。
@see Net::IMAP::TaggedResponse#data -
Net
:: IMAP :: TaggedResponse # tag -> String (42301.0) -
レスポンスに対応付けられたタグを返します。
レスポンスに対応付けられたタグを返します。 -
Net
:: IMAP :: UNMARKED -> Symbol (42301.0) -
「:Unmarked」というシンボルを返します。
「:Unmarked」というシンボルを返します。
メールボックスが
印付けられていないことを意味します。
メールボックスに新しいメールが届いていないことを意味します。
LIST応答の属性
(Net::IMAP#list、Net::IMAP::MailboxList#attr)
として用いられます。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: UntaggedResponse # data -> object (42301.0) -
レスポンスを解析した結果のオブジェクトを返します。
レスポンスを解析した結果のオブジェクトを返します。
レスポンスによって異なるオブジェクトを返します。
Net::IMAP::MailboxList であったりフラグを表わす
シンボルの配列であったりします。 -
Net
:: IMAP :: UntaggedResponse # name -> String (42301.0) -
レスポンスの名前(種類)を返します。
レスポンスの名前(種類)を返します。
例えば以下のような値を返します。これらの具体的な意味は
2060 を参考にしてください。
* "OK"
* "NO"
* "BAD"
* "BYE"
* "PREAUTH"
* "CAPABILITY"
* "LIST"
* "FLAGS"
* etc -
Net
:: IMAP :: UntaggedResponse # raw _ data -> String (42301.0) -
レスポンス文字列を返します。
レスポンス文字列を返します。
@see Net::IMAP::UntaggedResponse#data -
Net
:: IMAP (42001.0) -
IMAP 接続を表現するクラスです。
IMAP 接続を表現するクラスです。 -
Net
:: IMAP :: Address (42001.0) -
メールアドレスを表すクラスです。
メールアドレスを表すクラスです。 -
Net
:: IMAP :: BadResponseError (42001.0) -
サーバから "BAD" レスポンスが来た場合に発生する例外のクラスです。 クライアントからのコマンドが IMAP の規格から外れている場合や サーバ内部エラーの場合に発生します。
サーバから "BAD" レスポンスが来た場合に発生する例外のクラスです。
クライアントからのコマンドが IMAP の規格から外れている場合や
サーバ内部エラーの場合に発生します。 -
Net
:: IMAP :: BodyTypeBasic (42001.0) -
text 型(Net::IMAP::BodyTypeText)、 multipart 型(Net::IMAP::BodyTypeMultipart)、 message 型(Net::IMAP::BodyTypeMessage)、 のいずれでもないようなメッセージボディ構造を表すクラスです。
text 型(Net::IMAP::BodyTypeText)、
multipart 型(Net::IMAP::BodyTypeMultipart)、
message 型(Net::IMAP::BodyTypeMessage)、
のいずれでもないようなメッセージボディ構造を表すクラスです。
添付ファイルなどを表します。
詳しくは MIME のRFC(2045)を参照してください。 -
Net
:: IMAP :: BodyTypeMessage (42001.0) -
Content-Type が "message" であるメッセージを表すクラスです。
Content-Type が "message" であるメッセージを表すクラスです。
メールをメールに添付した場合などに使われます。
詳しくは 2045, 822 を参照してください。 -
Net
:: IMAP :: BodyTypeMultipart (42001.0) -
マルチパートなメッセージを表すクラスです。
マルチパートなメッセージを表すクラスです。
詳しくは MIME のRFC(2045)を参照してください。 -
Net
:: IMAP :: ContinuationRequest (42001.0) -
IMAP の continuation request (命令継続要求) を表すクラスです。
IMAP の continuation request (命令継続要求) を表すクラスです。
通常このクラスを直接扱うことはありません。
レスポンスハンドラ(Net::IMAP#add_response_handler)
に渡されます。
詳しくは 2060 の 7.5 を参照してください。 -
Net
:: IMAP :: FetchData (42001.0) -
FETCH コマンドの応答を表すクラスです。
FETCH コマンドの応答を表すクラスです。
Net::IMAP#fetch、Net::IMAP#uid_fetch、
Net::IMAP#store、Net::IMAP#uid_store の
返り値として利用されます。 -
Net
:: IMAP :: FlagCountError (42001.0) -
サーバからのレスポンスに含まれるフラグが多すぎるときに発生する例外です。
サーバからのレスポンスに含まれるフラグが多すぎるときに発生する例外です。
この上限は Net::IMAP.max_flag_count= で設定します。 -
Net
:: IMAP :: MailboxACLItem (42001.0) -
GETACL の応答の各要素を表すクラスです。
GETACL の応答の各要素を表すクラスです。
Net::IMAP#getacl の返り値として用いられます。
詳しくは 2086 を参照してください。 -
Net
:: IMAP :: MailboxList (42001.0) -
Net::IMAP#list、Net::IMAP#xlist、Net::IMAP#lsub で返されるメールボックスのデータを表します。
Net::IMAP#list、Net::IMAP#xlist、Net::IMAP#lsub
で返されるメールボックスのデータを表します。