ライブラリ
-
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 (192091.0) -
このライブラリは Internet Message Access Protocol (IMAP) の クライアントライブラリです。2060 を元に 実装されています。
このライブラリは Internet Message Access Protocol (IMAP) の
クライアントライブラリです。2060 を元に
実装されています。
=== IMAP の概要
IMAPを利用するには、まずサーバに接続し、
Net::IMAP#authenticate もしくは
Net::IMAP#login で認証します。
IMAP ではメールボックスという概念が重要です。
メールボックスは階層的な名前を持ちます。
各メールボックスはメールを保持することができます。
メールボックスの実装はサーバソフトウェアによって異なります。
Unixシステムでは、ディレクトリ階層上の
... -
NEWS for Ruby 2
. 0 . 0 (78037.0) -
NEWS for Ruby 2.0.0 このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
NEWS for Ruby 2.0.0
このドキュメントは前回リリース以降のバグ修正を除くユーザーに影響のある機能の変更のリストです。
それぞれのエントリーは参照情報があるため短いです。
十分な情報と共に書かれた全ての変更のリストは ChangeLog ファイルか bugs.ruby-lang.org の issue を参照してください。
== 1.9.3 以降の変更
=== 言語仕様の変更
* キーワード引数を追加しました
* %i, %I をシンボルの配列作成のために追加しました。(%w, %W に似ています)
* デフォルトのソースエンコーディングを US-ASCI... -
ruby 1
. 8 . 2 feature (69073.0) -
ruby 1.8.2 feature ruby 1.8.2 での ruby 1.8.1 からの変更点です。
ruby 1.8.2 feature
ruby 1.8.2 での ruby 1.8.1 からの変更点です。
掲載方針
*バグ修正の影響も含めて動作が変わるものを収録する。
*単にバグを直しただけのものは収録しない。
*ライブラリへの単なる定数の追加は収録しない。
以下は各変更点に付けるべきタグです。
*カテゴリ
* [ruby]: ruby インタプリタの変更
* [api]: 拡張ライブラリ API
* [lib]: ライブラリ
*レベル
* [bug]: バグ修正
* [new]: 追加されたクラス/メソッドなど
* [compat]: 変更されたクラス/... -
Net
:: IMAP . new(host , options) -> Net :: IMAP (51619.0) -
新たな Net::IMAP オブジェクトを生成し、指定したホストの 指定したポートに接続し、接続語の IMAP オブジェクトを返します。
新たな Net::IMAP オブジェクトを生成し、指定したホストの
指定したポートに接続し、接続語の IMAP オブジェクトを返します。
usessl が真ならば、サーバに繋ぐのに SSL/TLS を用います。
SSL/TLS での接続には OpenSSL と openssl が使える必要があります。
certs は利用する証明書のファイル名もしくは証明書があるディレクトリ名を
文字列で渡します。
certs に nil を渡すと、OpenSSL のデフォルトの証明書を使います。
verify は接続先を検証するかを真偽値で設定します。
真が OpenSSL::SSL::VERIFY_PE... -
Net
:: IMAP . new(host , port = 143 , usessl = false , certs = nil , verify = true) -> Net :: IMAP (51619.0) -
新たな Net::IMAP オブジェクトを生成し、指定したホストの 指定したポートに接続し、接続語の IMAP オブジェクトを返します。
新たな Net::IMAP オブジェクトを生成し、指定したホストの
指定したポートに接続し、接続語の IMAP オブジェクトを返します。
usessl が真ならば、サーバに繋ぐのに SSL/TLS を用います。
SSL/TLS での接続には OpenSSL と openssl が使える必要があります。
certs は利用する証明書のファイル名もしくは証明書があるディレクトリ名を
文字列で渡します。
certs に nil を渡すと、OpenSSL のデフォルトの証明書を使います。
verify は接続先を検証するかを真偽値で設定します。
真が OpenSSL::SSL::VERIFY_PE... -
Net
:: IMAP # examine(mailbox) -> Net :: IMAP :: TaggedResponse (51601.0) -
EXAMINE コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。
EXAMINE コマンドを送り、指定したメールボックスを処理対象の
メールボックスにします。
Net::IMAP#select と異なりセッション中はメールボックスが
読み取り専用となります。それ以外は select と同じです。
@param mailbox 処理対象としたいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError mailboxが存在しない等の理由でコマンドの実行に失敗
した場合に発生します。 -
Net
:: IMAP :: BodyTypeBasic # content _ id -> String | nil (51601.0) -
Content-ID の値を文字列で返します。
Content-ID の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # content _ id -> String | nil (51601.0) -
Content-ID の値を文字列で返します。
Content-ID の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeText # content _ id -> String | nil (51601.0) -
Content-ID の値を文字列で返します。
Content-ID の値を文字列で返します。
@see 2045 -
Net
:: IMAP # disconnect -> nil (51301.0) -
サーバとの接続を切断します。
サーバとの接続を切断します。
@see Net::IMAP#disconnected? -
Net
:: IMAP # disconnected? -> bool (51301.0) -
サーバとの接続が切断されていれば真を返します。
サーバとの接続が切断されていれば真を返します。
@see Net::IMAP#disconnect -
Net
:: IMAP # idle _ done -> () (51301.0) -
Net::IMAP#idle で 停止しているスレッドを1つ起こします。
Net::IMAP#idle で
停止しているスレッドを1つ起こします。 -
Net
:: IMAP :: BodyTypeMessage # lines -> Integer (51301.0) -
ボディのテキストの行数を返します。
ボディのテキストの行数を返します。 -
Net
:: IMAP :: BodyTypeText # lines -> Integer (51301.0) -
ボディの行数を返します。
ボディの行数を返します。 -
Net
:: IMAP :: ContentDisposition (51001.0) -
1806, 2183 で定義されている MIME の Content-Disposition フィールドを表すクラスです。
1806, 2183 で定義されている MIME の
Content-Disposition フィールドを表すクラスです。 -
Net
:: IMAP :: BodyTypeBasic # language -> String | [String] | nil (42901.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeMessage # language -> String | [String] | nil (42901.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeMultipart # language -> String | [String] | nil (42901.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeText # language -> String | [String] | nil (42901.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: ResponseError # response -> Net :: IMAP :: TaggedResponse | Net :: IMAP :: UntaggedResponse (42901.0) -
エラーとなったレスポンスを表すオブジェクトを返します。
エラーとなったレスポンスを表すオブジェクトを返します。 -
Net
:: IMAP . add _ authenticator(auth _ type , authenticator) -> () (42619.0) -
Net::IMAP#authenticate で使う 認証用クラスを設定します。
Net::IMAP#authenticate で使う
認証用クラスを設定します。
imap ライブラリに新たな認証方式を追加するために用います。
通常は使う必要はないでしょう。もしこれを用いて
認証方式を追加する場合は net/imap.rb の
Net::IMAP::LoginAuthenticator などを参考にしてください。
@param auth_type 認証の種類(文字列)
@param authenticator 認証クラス(Class オブジェクト) -
Net
:: IMAP # rename(mailbox , newname) -> Net :: IMAP :: TaggedResponse (42601.0) -
RENAME コマンドを送り、指定したメールボックスをリネームします。
RENAME コマンドを送り、指定したメールボックスをリネームします。
@param mailbox リネームするメールボックス(文字列)
@param newname リネーム後の名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
リネームできなかった場合に発生します。
指定した名前のメールボックスが存在しない場合や、
リネーム後の名前を持つメールボックスが既に存在する
場合に発生します。 -
Net
:: IMAP # unsubscribe(mailbox) -> Net :: IMAP :: TaggedResponse (42601.0) -
UNSUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合から 削除します。
UNSUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合から
削除します。
@param mailbox 削除するするメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
削除できなかった場合に発生します。
指定した名前のメールボックスが active/subscribe でなかった
場合などに発生します。 -
Net
:: IMAP . max _ flag _ count -> Integer (42601.0) -
サーバからのレスポンスに含まれる flag の上限を返します。
サーバからのレスポンスに含まれる flag の上限を返します。
これを越えた flag がレスポンスに含まれている場合は、
Net::IMAP::FlagCountError 例外が発生します。
@see Net::IMAP.max_flag_count= -
Net
:: IMAP . max _ flag _ count=(count) (42601.0) -
サーバからのレスポンスに含まれる flag の上限を設定します。
サーバからのレスポンスに含まれる flag の上限を設定します。
これを越えた flag がレスポンスに含まれている場合は、
Net::IMAP::FlagCountError 例外が発生します。
デフォルトは 10000 です。通常は変える必要はないでしょう。
@param count 設定する最大値の整数
@see Net::IMAP.max_flag_count -
Net
:: IMAP :: BodyTypeBasic # disposition -> Net :: IMAP :: ContentDisposition | nil (42601.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMessage # disposition -> Net :: IMAP :: ContentDisposition | nil (42601.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMessage # envelope -> Net :: IMAP :: Envelpe | nil (42601.0) -
メッセージのエンベロープを返します。
メッセージのエンベロープを返します。 -
Net
:: IMAP :: BodyTypeMultipart # disposition -> Net :: IMAP :: ContentDisposition | nil (42601.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeText # disposition -> Net :: IMAP :: ContentDisposition | nil (42601.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP # append(mailbox , message , flags = nil , date _ time = nil) -> Net :: IMAP :: TaggedResponse (42337.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 # 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 # authenticate(auth _ type , user , password) -> Net :: IMAP :: TaggedResponse (42301.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 (42301.0) -
このメソッドは obsolete です。使わないでください。
このメソッドは obsolete です。使わないでください。 -
Net
:: IMAP # client _ thread=(th) (42301.0) -
このメソッドは obsolete です。使わないでください。
このメソッドは obsolete です。使わないでください。 -
Net
:: IMAP # expunge -> [Integer] | nil (42301.0) -
EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを すべて処理中のメールボックスから削除します。
EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを
すべて処理中のメールボックスから削除します。
削除したメッセージの message sequence number を配列で返します。
@raise Net::IMAP::NoResponseError メールボックスが read-only である場合に発生します -
Net
:: IMAP # greeting -> Net :: IMAP :: UntaggedResponse (42301.0) -
サーバから最初に送られてくるメッセージ(greeting message) を返します。
サーバから最初に送られてくるメッセージ(greeting message)
を返します。 -
Net
:: IMAP # login(user , password) -> Net :: IMAP :: TaggedResponse (42301.0) -
LOGIN コマンドを送り、平文でパスワードを送りクライアント ユーザを認証します。
LOGIN コマンドを送り、平文でパスワードを送りクライアント
ユーザを認証します。
Net::IMAP#authenticate で "LOGIN" を使うのとは異なる
ことに注意してください。authenticate では AUTHENTICATE コマンドを
送ります。
認証成功時には
認証成功レスポンスを返り値として返します。
認証失敗時には例外が発生します。
@param user ユーザ名文字列
@param password パスワード文字列
@raise Net::IMAP::NoResponseError 認証に失敗した場合に発生します
@see Net::IMAP#... -
Net
:: IMAP # noop -> Net :: IMAP :: TaggedResponse (42301.0) -
NOOP コマンドを送ります。
NOOP コマンドを送ります。
このコマンドは何もしません。 -
Net
:: IMAP # remove _ response _ handler(handler) -> () (42301.0) -
レスポンスハンドラを削除します。
レスポンスハンドラを削除します。
@param handler 削除するハンドラ
@see Net::IMAP#add_response_handler -
Net
:: IMAP # response _ handlers -> Array (42301.0) -
設定されているレスポンスハンドラ全てを 配列で返します。
設定されているレスポンスハンドラ全てを
配列で返します。
@see Net::IMAP#add_response_handler -
Net
:: IMAP # responses -> { String => [object] } (42301.0) -
サーバから送られてきた untagged な応答の記録を返します。
サーバから送られてきた untagged な応答の記録を返します。
untagged な応答は種類ごとに記録されます。
応答の種類には "FLAGS", "OK", "UIDVALIDITY", "EXISTS" などがあり、
この文字列がハッシュテーブルのキーとなります。
そして各種類ごとに配列が用意され、untagged な応答を受信するたびに
その配列の末尾にその内容が記録されます。
例:
imap.select("inbox")
p imap.responses["EXISTS"].last
#=> 2
p imap.responses["UIDVALIDITY"... -
Net
:: IMAP . encode _ utf7(str) -> String (42301.0) -
UTF-8 の文字列を modified UTF-7 の文字列に変換します。
UTF-8 の文字列を modified UTF-7 の文字列に変換します。
modified UTF-7 は IMAP のメールボックス名に使われるエンコーディングで、
UTF-7 を修正したものです。
詳しくは Net::IMAP.encode_utf7 を見てください。
@param str 変換対象の UTF-8 でエンコードされた文字列
@see Net::IMAP.decode_utf7 -
Net
:: IMAP :: ANSWERED -> Symbol (42301.0) -
「:Answered」というシンボルを返します。
「:Answered」というシンボルを返します。
そのメッセージに返答したことを意味します。
フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: Address # name -> String | nil (42301.0) -
メールアドレスの 822 の個人名(personal name)を返します。
メールアドレスの 822 の個人名(personal name)を返します。
個人名が存在しない場合は nil を返します。
通常は nil を返します。 -
Net
:: IMAP :: BodyTypeBasic # description -> String | nil (42301.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeBasic # encoding -> String (42301.0) -
Content-Transfer-Encoding の値を文字列で返します。
Content-Transfer-Encoding の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeBasic # extension -> Array | nil (42301.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeMessage # description -> String | nil (42301.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # encoding -> String (42301.0) -
Content-Transfer-Encoding の値を文字列で返します。
Content-Transfer-Encoding の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # extension -> Array | nil (42301.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeMultipart # extension -> Array | nil (42301.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeText # description -> String | nil (42301.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeText # encoding -> String (42301.0) -
Content-Transfer-Encoding の値を文字列で返します。
Content-Transfer-Encoding の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeText # extension -> Array | nil (42301.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: Envelope # in _ reply _ to -> String | nil (42301.0) -
In-reply-to の内容を文字列で返します。
In-reply-to の内容を文字列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # sender -> [Net :: IMAP :: Address] | nil (42301.0) -
Sender を Net::IMAP::Address オブジェクトの配列で返します。
Sender を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: FetchData # seqno -> Integer (42301.0) -
メッセージの sequence number を返します。
メッセージの sequence number を返します。
Net::IMAP#uid_fetch、Net::IMAP#uid_storeであっても
UID ではなく、sequence numberを返します。 -
Net
:: IMAP :: MailboxList # name -> String (42301.0) -
メールボックスの名前を文字列で返します。
メールボックスの名前を文字列で返します。 -
Net
:: IMAP :: NOINFERIORS -> Symbol (42301.0) -
「:Noinferiors」というシンボルを返します。
「:Noinferiors」というシンボルを返します。
このメールボックスの
下に子レベルの階層が存在不可能であることを意味します。
LIST応答の属性
(Net::IMAP#list、Net::IMAP::MailboxList#attr)
として用いられます。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: NOSELECT -> Symbol (42301.0) -
「:Noselect」というシンボルを返します。
「:Noselect」というシンボルを返します。
メールボックスが選択可能でないことを意味します。
LIST応答の属性
(Net::IMAP#list、Net::IMAP::MailboxList#attr)
として用いられます。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: RECENT -> Symbol (42301.0) -
「:Recent」というシンボルを返します。
「:Recent」というシンボルを返します。
メッセージが「最近」メールボックスに到着したことを意味します。
フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: ResponseCode # name -> String (42301.0) -
レスポンスコードを表す文字列を返します。 "ALERT"、"PERMANENTFLAGS"、"UIDVALIDITY" などを返します。
レスポンスコードを表す文字列を返します。
"ALERT"、"PERMANENTFLAGS"、"UIDVALIDITY" などを返します。 -
Net
:: IMAP :: ResponseError # response=(resp) (42301.0) -
エラーとなったレスポンスを表すオブジェクトを設定します。
エラーとなったレスポンスを表すオブジェクトを設定します。
@param resp 設定するレスポンスオブジェクト -
Net
:: IMAP :: SEEN -> Symbol (42301.0) -
「:Seen」というシンボルを返します。
「:Seen」というシンボルを返します。
そのメッセージが既に読まれていることを意味します。
フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: TaggedResponse # name -> String (42301.0) -
レスポンスの名前(種類)を返します。
レスポンスの名前(種類)を返します。
例えば以下のような値を返します。これらの具体的な意味は
2060 を参考にしてください。
* "OK"
* "NO"
* "BAD" -
Net
:: IMAP :: ThreadMember # children -> [Net :: IMAP :: ThreadMember] (42301.0) -
スレッドの木構造における自身の下位の部分を返します。
スレッドの木構造における自身の下位の部分を返します。 -
Net
:: IMAP :: ThreadMember # seqno -> Integer | nil (42301.0) -
メッセージの sequence number もしくは UID を返します。
メッセージの sequence number もしくは UID を返します。
root となるメッセージが存在しない場合しない木の場合は
nil を返します。 -
Net
:: IMAP :: UNMARKED -> Symbol (42301.0) -
「:Unmarked」というシンボルを返します。
「:Unmarked」というシンボルを返します。
メールボックスが
印付けられていないことを意味します。
メールボックスに新しいメールが届いていないことを意味します。
LIST応答の属性
(Net::IMAP#list、Net::IMAP::MailboxList#attr)
として用いられます。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: UntaggedResponse # name -> String (42301.0) -
レスポンスの名前(種類)を返します。
レスポンスの名前(種類)を返します。
例えば以下のような値を返します。これらの具体的な意味は
2060 を参考にしてください。
* "OK"
* "NO"
* "BAD"
* "BYE"
* "PREAUTH"
* "CAPABILITY"
* "LIST"
* "FLAGS"
* etc -
Net
:: IMAP :: BadResponseError (42001.0) -
サーバから "BAD" レスポンスが来た場合に発生する例外のクラスです。 クライアントからのコマンドが IMAP の規格から外れている場合や サーバ内部エラーの場合に発生します。
サーバから "BAD" レスポンスが来た場合に発生する例外のクラスです。
クライアントからのコマンドが IMAP の規格から外れている場合や
サーバ内部エラーの場合に発生します。 -
Net
:: IMAP :: ByeResponseError (42001.0) -
サーバから "BYE" レスポンスが来た場合に発生する例外のクラスです。 ログインが拒否された場合や、クライアントが無反応で タイムアウトした場合に発生します。
サーバから "BYE" レスポンスが来た場合に発生する例外のクラスです。
ログインが拒否された場合や、クライアントが無反応で
タイムアウトした場合に発生します。 -
Net
:: IMAP :: ContinuationRequest (42001.0) -
IMAP の continuation request (命令継続要求) を表すクラスです。
IMAP の continuation request (命令継続要求) を表すクラスです。
通常このクラスを直接扱うことはありません。
レスポンスハンドラ(Net::IMAP#add_response_handler)
に渡されます。
詳しくは 2060 の 7.5 を参照してください。 -
Net
:: IMAP :: Envelope (42001.0) -
メッセージのエンベロープを表すクラスです。
メッセージのエンベロープを表すクラスです。
Net::IMAP::FetchData#attr の要素として用いられます。 -
Net
:: IMAP :: FlagCountError (42001.0) -
サーバからのレスポンスに含まれるフラグが多すぎるときに発生する例外です。
サーバからのレスポンスに含まれるフラグが多すぎるときに発生する例外です。
この上限は Net::IMAP.max_flag_count= で設定します。 -
Net
:: IMAP :: NoResponseError (42001.0) -
サーバから "NO" レスポンスが来た場合に発生する例外のクラスです。 コマンドが正常に完了しなかった場合に発生します。
サーバから "NO" レスポンスが来た場合に発生する例外のクラスです。
コマンドが正常に完了しなかった場合に発生します。 -
Net
:: IMAP :: ResponseCode (42001.0) -
応答のレスポンスコードを表すクラスです。
応答のレスポンスコードを表すクラスです。
レスポンスコードについては 2060 の 7.1 を参照してください。 -
Net
:: IMAP :: ResponseError (42001.0) -
サーバからのレスポンスがエラーを示している場合に発生する例外 のクラスです。
サーバからのレスポンスがエラーを示している場合に発生する例外
のクラスです。
実際にはこれを継承した
* Net::IMAP::NoResponseError
* Net::IMAP::BadResponseError
* Net::IMAP::ByeResponseError
これらのクラスの例外が発生します。 -
Net
:: IMAP :: ResponseParseError (42001.0) -
サーバからのレスポンスが正しくパースできない場合に発生する 例外のクラスです。
サーバからのレスポンスが正しくパースできない場合に発生する
例外のクラスです。 -
Net
:: IMAP :: ResponseText (42001.0) -
応答のテキストを表すクラスです。
応答のテキストを表すクラスです。 -
Net
:: IMAP :: TaggedResponse (42001.0) -
IMAP のタグ付きレスポンスを表すクラスです。
IMAP のタグ付きレスポンスを表すクラスです。
IMAP のレスポンスにはタグ付きのものとタグなしのものがあり、
タグ付きのレスポンスはクライアントが発行したコマンドによる
操作が成功するか失敗するかのどちらかで
完了したことを意味します。タグによって
どのコマンドが完了したのかを示します。
@see Net::IMAP::UntaggedResponse -
Net
:: IMAP :: UntaggedResponse (42001.0) -
IMAP のタグ付きレスポンスを表すクラスです。
IMAP のタグ付きレスポンスを表すクラスです。
IMAP のレスポンスにはタグ付きのものとタグなしのものがあり、
タグなしのものはクライアントからのコマンド完了応答ではない
レスポンスです。
@see Net::IMAP::TaggedResponse -
Net
:: IMAP :: BodyTypeMessage # body -> Net :: IMAP :: BodyTypeBasic | Net :: IMAP :: BodyTypeMessage | Net :: IMAP :: BodyTypeText | Net :: IMAP :: BodyTypeMultipart (34201.0) -
ボディを返します。
ボディを返します。 -
Net
:: IMAP :: BodyTypeMultipart # parts -> [Net :: IMAP :: BodyTypeBasic | Net :: IMAP :: BodyTypeText | Net :: IMAP :: BodyTypeMessage | Net :: IMAP :: BodyTypeMultipart] (34201.0) -
マルチパートの各部分を返します。
マルチパートの各部分を返します。 -
Net
:: IMAP # getquotaroot(mailbox) -> [Net :: IMAP :: MailboxQuotaRoot | Net :: IMAP :: MailboxQuota] (33601.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 # starttls(options) -> Net :: IMAP :: TaggedResponse (33601.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 :: BodyTypeBasic # param -> { String => String } | nil (33601.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # param -> { String => String } | nil (33601.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: BodyTypeMultipart # param -> { String => String } (33601.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: BodyTypeText # param -> { String => String } | nil (33601.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: ContentDisposition # param -> { String => String } | nil (33601.0) -
Content-Disposition フィールドのパラメータをハッシュテーブルで 返します。
Content-Disposition フィールドのパラメータをハッシュテーブルで
返します。
ハッシュテーブルのキーは以下のような値を取ります。詳しくは
2183 などを見てください。
* "FILENAME"
* "CREATION-DATE"
* "MODIFICATION-DATE"
* "READ-DAT"
* "SIZE" -
Net
:: IMAP # fetch(set , attr) -> [Net :: IMAP :: FetchData] (33337.0) -
FETCH コマンドを送り、メールボックス内のメッセージに 関するデータを取得します。
FETCH コマンドを送り、メールボックス内のメッセージに
関するデータを取得します。
Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを対象とします。
set で対象とするメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。
attr には取得するアトリビュートを文字列の配列で渡してください。
指定可能なアトリビュートについては Net::IMAP::FetchData#attr
を見てください。
例:
p imap.... -
Net
:: IMAP . format _ date(time) -> String (33319.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 (33319.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 # capability -> [String] (33301.0) -
CAPABILITY コマンドを送ってサーバがサポートしている 機能(capabilities)のリストを文字列の配列として返します。
CAPABILITY コマンドを送ってサーバがサポートしている
機能(capabilities)のリストを文字列の配列として返します。
capability は IMAP に関連する RFC などで定義されています。
imap.capability
# => ["IMAP4REV1", "UNSELECT", "IDLE", "NAMESPACE", "QUOTA", ... ] -
Net
:: IMAP # check -> Net :: IMAP :: TaggedResponse (33301.0) -
CHECK コマンドを送り、現在処理しているメールボックスの チェックポイントを要求します。
CHECK コマンドを送り、現在処理しているメールボックスの
チェックポイントを要求します。
チェックポイントの要求とは、サーバ内部で保留状態になっている
操作を完了させることを意味します。例えばメモリ上にあるメールの
データをディスクに書き込むため、fsyncを呼んだりすることです。
実際に何が行なわれるかはサーバの実装によりますし、何も行なわれない
場合もあります。 -
Net
:: IMAP # close -> Net :: IMAP :: TaggedResponse (33301.0) -
CLOSE コマンドを送り、処理中のメールボックスを閉じます。
CLOSE コマンドを送り、処理中のメールボックスを閉じます。
このコマンドによって、どのメールボックスも選択されていない
状態に移行します。
そして \Deleted フラグが付けられたメールがすべて削除されます。 -
Net
:: IMAP # copy(set , mailbox) -> Net :: IMAP :: TaggedResponse (33301.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 (33301.0) -
CREATE コマンドを送り、新しいメールボックスを作ります。
CREATE コマンドを送り、新しいメールボックスを作ります。
@param mailbox 新しいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスが作れなかった場合に発生します