種類
- インスタンスメソッド (152)
- クラス (28)
- 特異メソッド (16)
- 定数 (10)
クラス
-
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)
- 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)
- 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 :: ContinuationRequest (27007.0) -
IMAP の continuation request (命令継続要求) を表すクラスです。
IMAP の continuation request (命令継続要求) を表すクラスです。
通常このクラスを直接扱うことはありません。
レスポンスハンドラ(Net::IMAP#add_response_handler)
に渡されます。
詳しくは 2060 の 7.5 を参照してください。 -
Net
:: IMAP :: StatusData (27007.0) -
STATUS 応答を表わすクラスです。
STATUS 応答を表わすクラスです。 -
Net
:: IMAP # thread(algorithm , search _ keys , charset) -> [Net :: IMAP :: ThreadMember] (18907.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] (18907.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 . add _ authenticator(auth _ type , authenticator) -> () (18907.0) -
Net::IMAP#authenticate で使う 認証用クラスを設定します。
...追加するために用います。
通常は使う必要はないでしょう。もしこれを用いて
認証方式を追加する場合は net/imap.rb の
Net::IMAP::LoginAuthenticator などを参考にしてください。
@param auth_type 認証の種類(文字列)
@param authenticator 認... -
Net
:: IMAP # authenticate(auth _ type , user , password) -> Net :: IMAP :: TaggedResponse (18607.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 # fetch(set , attr) -> [Net :: IMAP :: FetchData] (18607.0) -
FETCH コマンドを送り、メールボックス内のメッセージに 関するデータを取得します。
FETCH コマンドを送り、メールボックス内のメッセージに
関するデータを取得します。
Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを対象とします。
set で対象とするメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。
attr には取得するアトリビュートを文字列の配列で渡してください。
指定可能なアトリビュートについては Net::IMAP::FetchData#attr
を見てください。
例:
p imap.... -
Net
:: IMAP # starttls(certs , verify) -> Net :: IMAP :: TaggedResponse (18607.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 (18607.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 _ fetch(set , attr) -> [Net :: IMAP :: FetchData] (18607.0) -
UID FETCH コマンドを送り、メールボックス内のメッセージに 関するデータを取得します。
UID FETCH コマンドを送り、メールボックス内のメッセージに
関するデータを取得します。
Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを対象とします。
set で対象とするメッセージを指定します。
これには UID、UID の配列、もしくは
Range オブジェクトを渡します。
attr には取得するアトリビュートを文字列の配列で渡してください。
指定可能なアトリビュートについては Net::IMAP::FetchData#attr
を見てください。
@param set 処理対象のメッセージの UID
@param... -
Net
:: IMAP :: BodyTypeBasic # disposition -> Net :: IMAP :: ContentDisposition | nil (18607.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMessage # disposition -> Net :: IMAP :: ContentDisposition | nil (18607.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMultipart # disposition -> Net :: IMAP :: ContentDisposition | nil (18607.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeText # disposition -> Net :: IMAP :: ContentDisposition | nil (18607.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP # capability -> [String] (18307.0) -
CAPABILITY コマンドを送ってサーバがサポートしている 機能(capabilities)のリストを文字列の配列として返します。
CAPABILITY コマンドを送ってサーバがサポートしている
機能(capabilities)のリストを文字列の配列として返します。
capability は IMAP に関連する RFC などで定義されています。
imap.capability
# => ["IMAP4REV1", "UNSELECT", "IDLE", "NAMESPACE", "QUOTA", ... ] -
Net
:: IMAP # client _ thread -> Thread (18307.0) -
このメソッドは obsolete です。使わないでください。
このメソッドは obsolete です。使わないでください。 -
Net
:: IMAP # client _ thread=(th) (18307.0) -
このメソッドは obsolete です。使わないでください。
このメソッドは obsolete です。使わないでください。 -
Net
:: IMAP # create(mailbox) -> Net :: IMAP :: TaggedResponse (18307.0) -
CREATE コマンドを送り、新しいメールボックスを作ります。
CREATE コマンドを送り、新しいメールボックスを作ります。
@param mailbox 新しいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスが作れなかった場合に発生します -
Net
:: IMAP # delete(mailbox) -> Net :: IMAP :: TaggedResponse (18307.0) -
DELETE コマンドを送り、指定したメールボックスを削除します。
DELETE コマンドを送り、指定したメールボックスを削除します。
@param mailbox 削除するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを削除できなかった場合
に発生します。指定した名前のメールボックスが存在しない場合や、
ユーザにメールボックスを削除する権限がない場合に発生します。 -
Net
:: IMAP # disconnect -> nil (18307.0) -
サーバとの接続を切断します。
サーバとの接続を切断します。
@see Net::IMAP#disconnected? -
Net
:: IMAP # disconnected? -> bool (18307.0) -
サーバとの接続が切断されていれば真を返します。
サーバとの接続が切断されていれば真を返します。
@see Net::IMAP#disconnect -
Net
:: IMAP # getacl(mailbox) -> [Net :: IMAP :: MailboxACLItem] (18307.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 # getquota(mailbox) -> [Net :: IMAP :: MailboxQuota] (18307.0) -
GETQUOTA コマンドを送って 指定したメールボックスの quota の情報を返します。
GETQUOTA コマンドを送って
指定したメールボックスの quota の情報を返します。
quota の情報は Net::IMAP::MailboxQuota オブジェクトの配列で
得られます。
詳しくは 2087 を見てください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
@param mailbox quota 情報を得たいメールボックス名
@raise Net::IMAP::NoResponseError 指定したメールボックスが quota root でない場合に発生します -
Net
:: IMAP # getquotaroot(mailbox) -> [Net :: IMAP :: MailboxQuotaRoot | Net :: IMAP :: MailboxQuota] (18307.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 (18307.0) -
サーバから最初に送られてくるメッセージ(greeting message) を返します。
サーバから最初に送られてくるメッセージ(greeting message)
を返します。 -
Net
:: IMAP # list(refname , mailbox) -> [Net :: IMAP :: MailboxList] | nil (18307.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 # logout -> Net :: IMAP :: TaggedResponse (18307.0) -
LOGOUT コマンドを送り、コネクションを切断することを サーバに伝えます。
LOGOUT コマンドを送り、コネクションを切断することを
サーバに伝えます。 -
Net
:: IMAP # select(mailbox) -> Net :: IMAP :: TaggedResponse (18307.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) (18307.0) -
SETACL コマンドを送り、指定したメールボックスに 指定したユーザに関する権限を設定します。
SETACL コマンドを送り、指定したメールボックスに
指定したユーザに関する権限を設定します。
rights には設定する権限を表す文字列を指定します。
どのような文字列を指定すべきかは 2086 を参照してください。
rights に nil を渡すと、空文字列を指定したのと同様、つまり
すべての権限を削除します。
@param mailbox 権限を設定するメールボックスの名前(文字列)
@param user 権限を設定するユーザの名前(文字列)
@param rights 権限を表す文字列 -
Net
:: IMAP # setquota(mailbox , quota) -> Net :: IMAP :: TaggedResponse (18307.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 # sort(sort _ keys , search _ keys , charset) -> [Integer] (18307.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 # status(mailbox , attr) -> {String => Integer} (18307.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 (18307.0) -
STORE コマンドを送り、メールボックス内のメッセージを 更新します。
STORE コマンドを送り、メールボックス内のメッセージを
更新します。
set で更新するメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。
Net::IMAP#select で指定したメールボックスを対象とします。
attr で何をどのように変化させるかを指定します。
以下を指定することができます。
* "FLAGS"
* "+FLAGS"
* "-FLAGS"
それぞれメッセージのフラグの置き換え、追加、削除を意味します。
詳しくは 2060 の 6.4.6 を参考に... -
Net
:: IMAP # uid _ sort(sort _ keys , search _ keys , charset) -> [Integer] (18307.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 # uid _ store(set , attr , flags) -> [Net :: IMAP :: FetchData] | nil (18307.0) -
UID STORE コマンドを送り、メールボックス内のメッセージを 更新します。
UID STORE コマンドを送り、メールボックス内のメッセージを
更新します。
set で更新するメッセージを指定します。
これには UID、UID の配列、もしくは
Range オブジェクトを渡します。
Net::IMAP#select で指定したメールボックスを対象とします。
attr で何をどのように変化させるかを指定します。
以下を指定することができます。
* "FLAGS"
* "+FLAGS"
* "-FLAGS"
それぞれメッセージのフラグの置き換え、追加、削除を意味します。
詳しくは 2060 の 6.4.6 を参考にしてください。
返り値は更新された内... -
Net
:: IMAP # xlist(refname , mailbox) -> [Net :: IMAP :: MailboxList] (18307.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 . decode _ utf7(str) -> String (18307.0) -
modified UTF-7 の文字列を UTF-8 の文字列に変換します。
modified UTF-7 の文字列を UTF-8 の文字列に変換します。
modified UTF-7 は IMAP のメールボックス名に使われるエンコーディングで、
UTF-7 を修正したものです。
詳しくは 2060 の 5.1.3 を参照してください。
Net::IMAP ではメールボックス名のエンコードを自動的変換「しない」
ことに注意してください。必要があればユーザが変換すべきです。
@param str 変換対象の modified UTF-7 でエンコードされた文字列
@see Net::IMAP.encode_utf7 -
Net
:: IMAP . default _ imap _ port -> Integer (18307.0) -
デフォルトの IMAP のポート番号(143)を返します。
デフォルトの IMAP のポート番号(143)を返します。
@see Net::IMAP.default_tls_port -
Net
:: IMAP . default _ imaps _ port -> Integer (18307.0) -
デフォルトの IMAPS のポート番号(993)を返します。
デフォルトの IMAPS のポート番号(993)を返します。
@see Net::IMAP.default_port -
Net
:: IMAP . default _ port -> Integer (18307.0) -
デフォルトの IMAP のポート番号(143)を返します。
デフォルトの IMAP のポート番号(143)を返します。
@see Net::IMAP.default_tls_port -
Net
:: IMAP . default _ ssl _ port -> Integer (18307.0) -
デフォルトの IMAPS のポート番号(993)を返します。
デフォルトの IMAPS のポート番号(993)を返します。
@see Net::IMAP.default_port -
Net
:: IMAP . default _ tls _ port -> Integer (18307.0) -
デフォルトの IMAPS のポート番号(993)を返します。
デフォルトの IMAPS のポート番号(993)を返します。
@see Net::IMAP.default_port -
Net
:: IMAP . encode _ utf7(str) -> String (18307.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 . format _ date(time) -> String (18307.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 (18307.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 . max _ flag _ count -> Integer (18307.0) -
サーバからのレスポンスに含まれる flag の上限を返します。
サーバからのレスポンスに含まれる flag の上限を返します。
これを越えた flag がレスポンスに含まれている場合は、
Net::IMAP::FlagCountError 例外が発生します。
@see Net::IMAP.max_flag_count= -
Net
:: IMAP . max _ flag _ count=(count) (18307.0) -
サーバからのレスポンスに含まれる flag の上限を設定します。
サーバからのレスポンスに含まれる flag の上限を設定します。
これを越えた flag がレスポンスに含まれている場合は、
Net::IMAP::FlagCountError 例外が発生します。
デフォルトは 10000 です。通常は変える必要はないでしょう。
@param count 設定する最大値の整数
@see Net::IMAP.max_flag_count -
Net
:: IMAP :: Address # host -> String | nil (18307.0) -
メールアドレスのホスト名を返します。
メールアドレスのホスト名を返します。
nil は 822 のグループ文法に対応します。
これについては Net::IMAP::Address#mailbox も参照してください。
そうでない場合は 822 のドメイン名を表します。
通常は、メールアドレスの「@」の後ろのドメイン名を返します。 -
Net
:: IMAP :: Address # route -> String | nil (18307.0) -
メールアドレスの SMTP at-domain-list を返します。
メールアドレスの SMTP at-domain-list を返します。
存在しない場合は nil を返します。
通常は nil を返します。 -
Net
:: IMAP :: BodyTypeBasic # content _ id -> String | nil (18307.0) -
Content-ID の値を文字列で返します。
Content-ID の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeBasic # description -> String | nil (18307.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeBasic # extension -> Array | nil (18307.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeBasic # media _ subtype -> String (18307.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeBasic#media_type -
Net
:: IMAP :: BodyTypeBasic # media _ type -> String (18307.0) -
MIME のメディアタイプを返します。
MIME のメディアタイプを返します。
@see Net::IMAP::BodyTypeBasic#subtype -
Net
:: IMAP :: BodyTypeBasic # multipart? -> bool (18307.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: BodyTypeBasic # subtype -> String (18307.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeBasic#media_type -
Net
:: IMAP :: BodyTypeMessage # content _ id -> String | nil (18307.0) -
Content-ID の値を文字列で返します。
Content-ID の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # description -> String | nil (18307.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # extension -> Array | nil (18307.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeMessage # media _ subtype -> String (18307.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeMessage#media_type -
Net
:: IMAP :: BodyTypeMessage # media _ type -> String (18307.0) -
MIME のメディアタイプを返します。
MIME のメディアタイプを返します。
これは "MESSAGE" を返します。
@see Net::IMAP::BodyTypeMessage#subtype -
Net
:: IMAP :: BodyTypeMessage # multipart? -> bool (18307.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: BodyTypeMessage # subtype -> String (18307.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeMessage#media_type -
Net
:: IMAP :: BodyTypeMultipart # extension -> Array | nil (18307.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeMultipart # media _ subtype -> String (18307.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see 2045, Net::IMAP::BodyTypeText#media_type -
Net
:: IMAP :: BodyTypeMultipart # media _ type -> String (18307.0) -
MIME のメディアタイプを返します。
MIME のメディアタイプを返します。
"MULTIPART" を返します。
@see Net::IMAP::BodyTypeMultipart#subtype -
Net
:: IMAP :: BodyTypeMultipart # multipart? -> bool (18307.0) -
マルチパートかどうかを返します。 true を返します。
マルチパートかどうかを返します。
true を返します。 -
Net
:: IMAP :: BodyTypeMultipart # parts -> [Net :: IMAP :: BodyTypeBasic | Net :: IMAP :: BodyTypeText | Net :: IMAP :: BodyTypeMessage | Net :: IMAP :: BodyTypeMultipart] (18307.0) -
マルチパートの各部分を返します。
マルチパートの各部分を返します。 -
Net
:: IMAP :: BodyTypeMultipart # subtype -> String (18307.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see 2045, Net::IMAP::BodyTypeText#media_type -
Net
:: IMAP :: BodyTypeText # content _ id -> String | nil (18307.0) -
Content-ID の値を文字列で返します。
Content-ID の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeText # description -> String | nil (18307.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeText # extension -> Array | nil (18307.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeText # media _ subtype -> String (18307.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeText#media_type -
Net
:: IMAP :: BodyTypeText # media _ type -> String (18307.0) -
MIME のメディアタイプを返します。
MIME のメディアタイプを返します。
これは "TEXT" を返します。
@see Net::IMAP::BodyTypeText#subtype -
Net
:: IMAP :: BodyTypeText # multipart? -> bool (18307.0) -
マルチパートかどうかを返します。 false を返します。
マルチパートかどうかを返します。
false を返します。 -
Net
:: IMAP :: BodyTypeText # subtype -> String (18307.0) -
MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。
MIME のメディアタイプのサブタイプを返します。
media_subtype は obsolete です。
@see Net::IMAP::BodyTypeText#media_type -
Net
:: IMAP :: ContentDisposition # dsp _ type -> String (18307.0) -
Content-Disposition フィールドのタイプを文字列で返します。
Content-Disposition フィールドのタイプを文字列で返します。
"INLINE", "ATTACHMENT" などの文字列を返します。
詳しくは 2183 などを見てください。 -
Net
:: IMAP :: ContinuationRequest # data -> Net :: IMAP :: ResponseText (18307.0) -
レスポンスのデータを返します。
レスポンスのデータを返します。 -
Net
:: IMAP :: ContinuationRequest # raw _ data -> String (18307.0) -
レスポンス文字列を返します。
レスポンス文字列を返します。 -
Net
:: IMAP :: DELETED -> Symbol (18307.0) -
「:Deleted」というシンボルを返します。
「:Deleted」というシンボルを返します。
メッセージが削除されていることを意味します。
EXPUNGE で完全に除去されます。
フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: DRAFT -> Symbol (18307.0) -
「:Draft」というシンボルを返します。
「:Draft」というシンボルを返します。
メッセージが草稿であることを意味します。
フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: Envelope # date -> String | nil (18307.0) -
日付の文字列を返します。
日付の文字列を返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # in _ reply _ to -> String | nil (18307.0) -
In-reply-to の内容を文字列で返します。
In-reply-to の内容を文字列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # reply _ to -> [Net :: IMAP :: Address] | nil (18307.0) -
Reply-To を Net::IMAP::Address オブジェクトの配列で返します。
Reply-To を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # subject -> String | nil (18307.0) -
メッセージのサブジェクトを返します。
メッセージのサブジェクトを返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # to -> [Net :: IMAP :: Address] | nil (18307.0) -
To を Net::IMAP::Address オブジェクトの配列で返します。
To を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: FetchData # attr -> { String => object } (18307.0) -
各メッセージのアトリビュートの値をハッシュテーブルで返します。
各メッセージのアトリビュートの値をハッシュテーブルで返します。
キーはアトリビュート名の文字列、値はアトリビュートの値となります。
値のクラスはアトリビュートによって異なります。
利用可能なアトリビュートは以下の通りです。
: BODY
BODYSTRUCTURE の拡張データなしの形式。
Net::IMAP::BodyTypeBasic, Net::IMAP::BodyTypeText,
Net::IMAP::BodyTypeMessage, Net::IMAP::BodyTypeMultipart
のいずれか。
: BODY[<section>]<<... -
Net
:: IMAP :: MailboxACLItem # rights -> String (18307.0) -
アクセス権限を文字列で返します。
アクセス権限を文字列で返します。
Net::IMAP::MailboxACLItem#user で得られるユーザが
持っている権限が返されます。
この文字列の意味については 2086 を参照してください。 -
Net
:: IMAP :: MailboxList # attr -> [Symbol] (18307.0) -
メールボックスの属性をシンボルの配列で返します。
メールボックスの属性をシンボルの配列で返します。
これで得られるシンボルは String#capitalize でキャピタライズ
されています。
この配列には例えば以下のような値を含んでいます。
詳しくは 2060 7.2.2 などを参照してください。
以下のもの以外で、IMAP 関連 RFC で拡張された値を含んでいる
場合もあります
* :Noselect
* :Noinferiors
* :Marked
* :Unmarked -
Net
:: IMAP :: MailboxQuota # quota -> Integer (18307.0) -
メールボックスに指定されている上限値を返します。
メールボックスに指定されている上限値を返します。 -
Net
:: IMAP :: MailboxQuotaRoot # quotaroots -> [String] (18307.0) -
問い合わせしたメールボックスの quota root 名を配列で返します。
問い合わせしたメールボックスの quota root 名を配列で返します。
空の場合もありえます。 -
Net
:: IMAP :: NOSELECT -> Symbol (18307.0) -
「:Noselect」というシンボルを返します。
「:Noselect」というシンボルを返します。
メールボックスが選択可能でないことを意味します。
LIST応答の属性
(Net::IMAP#list、Net::IMAP::MailboxList#attr)
として用いられます。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: RECENT -> Symbol (18307.0) -
「:Recent」というシンボルを返します。
「:Recent」というシンボルを返します。
メッセージが「最近」メールボックスに到着したことを意味します。
フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: ResponseCode # data -> object | nil (18307.0) -
レスポンスコードのデータを返します。
レスポンスコードのデータを返します。
レスポンスコードの種類によって返すオブジェクトは異なります。
ない場合は nil を返します。 -
Net
:: IMAP :: ResponseText # text -> String (18307.0) -
応答のテキストを文字列で返します。
応答のテキストを文字列で返します。 -
Net
:: IMAP :: StatusData # attr -> { String => Integer } (18307.0) -
STATUS 応答の内容をハッシュで返します。
STATUS 応答の内容をハッシュで返します。
ハッシュのキーは
"MESSAGES", "RECENT", "UIDNEXT", "UIDVALIDITY", "UNSEEN"
などが使われます。
詳しくは 2060 の 6.3.10、7.2.4 を見てください。 -
Net
:: IMAP :: TaggedResponse # data -> Net :: IMAP :: ResponseText (18307.0) -
レスポンスを解析したオブジェクトを返します。
レスポンスを解析したオブジェクトを返します。
@see Net::IMAP::ResponseText -
Net
:: IMAP :: TaggedResponse # raw _ data -> String (18307.0) -
レスポンス文字列を返します。
レスポンス文字列を返します。
@see Net::IMAP::TaggedResponse#data -
Net
:: IMAP :: TaggedResponse # tag -> String (18307.0) -
レスポンスに対応付けられたタグを返します。
レスポンスに対応付けられたタグを返します。 -
Net
:: IMAP :: UntaggedResponse # data -> object (18307.0) -
レスポンスを解析した結果のオブジェクトを返します。
レスポンスを解析した結果のオブジェクトを返します。
レスポンスによって異なるオブジェクトを返します。
Net::IMAP::MailboxList であったりフラグを表わす
シンボルの配列であったりします。