ライブラリ
-
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)
-
net
/ imap (1) - 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) -
ruby 1
. 9 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 . default _ imap _ port -> Integer (27370.0) -
デフォルトの IMAP のポート番号(143)を返します。
デフォルトの IMAP のポート番号(143)を返します。
@see Net::IMAP.default_tls_port -
Net
:: IMAP . default _ imaps _ port -> Integer (27319.0) -
デフォルトの IMAPS のポート番号(993)を返します。
デフォルトの IMAPS のポート番号(993)を返します。
@see Net::IMAP.default_port -
net
/ imap (19003.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 . default _ port -> Integer (18070.0) -
デフォルトの IMAP のポート番号(143)を返します。
デフォルトの IMAP のポート番号(143)を返します。
@see Net::IMAP.default_tls_port -
Net
:: IMAP (18049.0) -
IMAP 接続を表現するクラスです。
IMAP 接続を表現するクラスです。 -
Net
:: IMAP . default _ ssl _ port -> Integer (18019.0) -
デフォルトの IMAPS のポート番号(993)を返します。
デフォルトの IMAPS のポート番号(993)を返します。
@see Net::IMAP.default_port -
Net
:: IMAP . default _ tls _ port -> Integer (18019.0) -
デフォルトの IMAPS のポート番号(993)を返します。
デフォルトの IMAPS のポート番号(993)を返します。
@see Net::IMAP.default_port -
Net
:: IMAP :: BodyTypeMessage # body -> Net :: IMAP :: BodyTypeBasic | Net :: IMAP :: BodyTypeMessage | Net :: IMAP :: BodyTypeText | Net :: IMAP :: BodyTypeMultipart (10213.0) -
ボディを返します。
ボディを返します。 -
Net
:: IMAP :: BodyTypeMultipart # parts -> [Net :: IMAP :: BodyTypeBasic | Net :: IMAP :: BodyTypeText | Net :: IMAP :: BodyTypeMessage | Net :: IMAP :: BodyTypeMultipart] (10213.0) -
マルチパートの各部分を返します。
マルチパートの各部分を返します。 -
Net
:: IMAP # getquotaroot(mailbox) -> [Net :: IMAP :: MailboxQuotaRoot | Net :: IMAP :: MailboxQuota] (9679.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 :: ResponseError # response -> Net :: IMAP :: TaggedResponse | Net :: IMAP :: UntaggedResponse (9607.0) -
エラーとなったレスポンスを表すオブジェクトを返します。
エラーとなったレスポンスを表すオブジェクトを返します。 -
Net
:: IMAP # fetch(set , attr) -> [Net :: IMAP :: FetchData] (9502.0) -
FETCH コマンドを送り、メールボックス内のメッセージに 関するデータを取得します。
FETCH コマンドを送り、メールボックス内のメッセージに
関するデータを取得します。
Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを対象とします。
set で対象とするメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。
attr には取得するアトリビュートを文字列の配列で渡してください。
指定可能なアトリビュートについては Net::IMAP::FetchData#attr
を見てください。
例:
p imap.... -
Net
:: IMAP . new(host , options) -> Net :: IMAP (9475.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 (9475.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 # store(set , attr , flags) -> [Net :: IMAP :: FetchData] | nil (9448.0) -
STORE コマンドを送り、メールボックス内のメッセージを 更新します。
STORE コマンドを送り、メールボックス内のメッセージを
更新します。
set で更新するメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。
Net::IMAP#select で指定したメールボックスを対象とします。
attr で何をどのように変化させるかを指定します。
以下を指定することができます。
* "FLAGS"
* "+FLAGS"
* "-FLAGS"
それぞれメッセージのフラグの置き換え、追加、削除を意味します。
詳しくは 2060 の 6.4.6 を参考に... -
Net
:: IMAP # xlist(refname , mailbox) -> [Net :: IMAP :: MailboxList] (9448.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 # list(refname , mailbox) -> [Net :: IMAP :: MailboxList] | nil (9430.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 # idle {|resp| . . . } -> Net :: IMAP :: TaggedResponse (9376.0) -
IDLE 命令を送り、メールボックスの非同期的変化を待ち受けます。
IDLE 命令を送り、メールボックスの非同期的変化を待ち受けます。
このメソッドに渡したブロックは
Net::IMAP#add_response_handler によって
レスポンスハンドラとして用いられます。
また、このメソッドが終了する時点で
Net::IMAP#remove_response_handler で
ハンドラが削除されます。
レスポンスハンドラについては
Net::IMAP#add_response_handler を参照してください。
別のスレッドが Net::IMAP#idle_done を呼びだすまで
このメソッドを呼びだしたスレッドは停止します。
この命令は ... -
Net
:: IMAP # select(mailbox) -> Net :: IMAP :: TaggedResponse (9376.0) -
SELECT コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。
SELECT コマンドを送り、指定したメールボックスを処理対象の
メールボックスにします。
このコマンドが成功すると、クライアントの状態が「selected」になります。
このコマンドを実行した直後に Net::IMAP#responses["EXISTS"].last
を調べると、メールボックス内のメールの数がわかります。
また、Net::IMAP#responses["RECENT"].lastで、
最新のメールの数がわかります。
これらの値はセッション中に変わりうることに注意してください。
Net::IMAP#add_response_handler を使うとそのような更新情報を
即... -
Net
:: IMAP # thread(algorithm , search _ keys , charset) -> [Net :: IMAP :: ThreadMember] (9376.0) -
THREADコマンドを送り、メールボックスを検索した結果を スレッド形式の木構造で返します。
THREADコマンドを送り、メールボックスを検索した結果を
スレッド形式の木構造で返します。
THREAD コマンドは 5256 で定義されています。
詳しくはそちらを参照してください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
algorithm は木構造を決定するためのアルゴリズムを指定します。
以下の2つが利用可能です。
* "ORDEREDSUBJECT" subjectを使って平坦に区切るだけ
* "REFERENCES" どのメッセージに返事をしているかを見て木構造を作る
詳しくは 5256 を見てく... -
Net
:: IMAP # uid _ fetch(set , attr) -> [Net :: IMAP :: FetchData] (9376.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 # uid _ store(set , attr , flags) -> [Net :: IMAP :: FetchData] | nil (9376.0) -
UID STORE コマンドを送り、メールボックス内のメッセージを 更新します。
UID STORE コマンドを送り、メールボックス内のメッセージを
更新します。
set で更新するメッセージを指定します。
これには UID、UID の配列、もしくは
Range オブジェクトを渡します。
Net::IMAP#select で指定したメールボックスを対象とします。
attr で何をどのように変化させるかを指定します。
以下を指定することができます。
* "FLAGS"
* "+FLAGS"
* "-FLAGS"
それぞれメッセージのフラグの置き換え、追加、削除を意味します。
詳しくは 2060 の 6.4.6 を参考にしてください。
返り値は更新された内... -
Net
:: IMAP # uid _ thread(algorithm , search _ keys , charset) -> [Net :: IMAP :: ThreadMember] (9376.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 # copy(set , mailbox) -> Net :: IMAP :: TaggedResponse (9358.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 # getacl(mailbox) -> [Net :: IMAP :: MailboxACLItem] (9358.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] (9358.0) -
GETQUOTA コマンドを送って 指定したメールボックスの quota の情報を返します。
GETQUOTA コマンドを送って
指定したメールボックスの quota の情報を返します。
quota の情報は Net::IMAP::MailboxQuota オブジェクトの配列で
得られます。
詳しくは 2087 を見てください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
@param mailbox quota 情報を得たいメールボックス名
@raise Net::IMAP::NoResponseError 指定したメールボックスが quota root でない場合に発生します -
Net
:: IMAP # login(user , password) -> Net :: IMAP :: TaggedResponse (9358.0) -
LOGIN コマンドを送り、平文でパスワードを送りクライアント ユーザを認証します。
LOGIN コマンドを送り、平文でパスワードを送りクライアント
ユーザを認証します。
Net::IMAP#authenticate で "LOGIN" を使うのとは異なる
ことに注意してください。authenticate では AUTHENTICATE コマンドを
送ります。
認証成功時には
認証成功レスポンスを返り値として返します。
認証失敗時には例外が発生します。
@param user ユーザ名文字列
@param password パスワード文字列
@raise Net::IMAP::NoResponseError 認証に失敗した場合に発生します
@see Net::IMAP#... -
Net
:: IMAP # move(set , mailbox) -> Net :: IMAP :: TaggedResponse (9358.0) -
MOVEコマンドを送り、set で指定したメッセージを mailbox の 末尾に移動させます。
MOVEコマンドを送り、set で指定したメッセージを mailbox の
末尾に移動させます。
set はmessage sequence number(整数)、
message sequence numberの配列、もしくは Range で
指定します。
コピー元のメールボックスは
Net::IMAP#examine もしくは Net::IMAP#select で
指定したものを用います。
@param set 移動するメッセージの message sequence number(整数、整数の配列、整数の Range)
@param mailbox 移動先のメールボックス(文字列)
... -
Net
:: IMAP # uid _ copy(set , mailbox) -> Net :: IMAP :: TaggedResponse (9358.0) -
UID COPY コマンドを送り、指定したメッセージを 指定したメールボックスの末尾に追加します。
UID COPY コマンドを送り、指定したメッセージを
指定したメールボックスの末尾に追加します。
set でコピーするメッセージを指定します。
UID (整数)、
UID の配列、もしくは Range で
指定します。コピー元のメールボックスは
Net::IMAP#examine もしくは Net::IMAP#select で
指定したものを用います。
mailbox はコピー先のメールボックスです。
@param set コピーするメッセージの UID
@param mailbox コピー先のメールボックス(文字列)
@see Net::IMAP#copy -
Net
:: IMAP # uid _ move(set , mailbox) -> Net :: IMAP :: TaggedResponse (9358.0) -
MOVEコマンドを送り、set でUIDで指定したメッセージを mailbox の 末尾に移動させます。
MOVEコマンドを送り、set でUIDで指定したメッセージを mailbox の
末尾に移動させます。
set には UID、UID の配列、もしくは
Range オブジェクトを渡します。
コピー元のメールボックスは
Net::IMAP#examine もしくは Net::IMAP#select で
指定したものを用います。
@param set 移動するメッセージのUID(整数、整数の配列、整数の Range)
@param mailbox 移動先のメールボックス(文字列)
@see Net::IMAP#move, 6851 -
Net
:: IMAP :: Envelope # bcc -> [Net :: IMAP :: Address] | nil (9352.0) -
Bcc を Net::IMAP::Address オブジェクトの配列で返します。
Bcc を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # cc -> [Net :: IMAP :: Address] | nil (9352.0) -
Cc を Net::IMAP::Address オブジェクトの配列で返します。
Cc を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # from -> [Net :: IMAP :: Address] | nil (9352.0) -
From を Net::IMAP::Address オブジェクトの配列で返します。
From を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # reply _ to -> [Net :: IMAP :: Address] | nil (9352.0) -
Reply-To を Net::IMAP::Address オブジェクトの配列で返します。
Reply-To を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # sender -> [Net :: IMAP :: Address] | nil (9352.0) -
Sender を Net::IMAP::Address オブジェクトの配列で返します。
Sender を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # to -> [Net :: IMAP :: Address] | nil (9352.0) -
To を Net::IMAP::Address オブジェクトの配列で返します。
To を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP # starttls(certs , verify) -> Net :: IMAP :: TaggedResponse (9343.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 (9343.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 # append(mailbox , message , flags = nil , date _ time = nil) -> Net :: IMAP :: TaggedResponse (9340.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 # authenticate(auth _ type , user , password) -> Net :: IMAP :: TaggedResponse (9340.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 # examine(mailbox) -> Net :: IMAP :: TaggedResponse (9340.0) -
EXAMINE コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。
EXAMINE コマンドを送り、指定したメールボックスを処理対象の
メールボックスにします。
Net::IMAP#select と異なりセッション中はメールボックスが
読み取り専用となります。それ以外は select と同じです。
@param mailbox 処理対象としたいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError mailboxが存在しない等の理由でコマンドの実行に失敗
した場合に発生します。 -
Net
:: IMAP # setquota(mailbox , quota) -> Net :: IMAP :: TaggedResponse (9340.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 # create(mailbox) -> Net :: IMAP :: TaggedResponse (9322.0) -
CREATE コマンドを送り、新しいメールボックスを作ります。
CREATE コマンドを送り、新しいメールボックスを作ります。
@param mailbox 新しいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスが作れなかった場合に発生します -
Net
:: IMAP # delete(mailbox) -> Net :: IMAP :: TaggedResponse (9322.0) -
DELETE コマンドを送り、指定したメールボックスを削除します。
DELETE コマンドを送り、指定したメールボックスを削除します。
@param mailbox 削除するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを削除できなかった場合
に発生します。指定した名前のメールボックスが存在しない場合や、
ユーザにメールボックスを削除する権限がない場合に発生します。 -
Net
:: IMAP # lsub(refname , mailbox) -> [Net :: IMAP :: MailboxList] (9322.0) -
LIST コマンドを送り、active/subscribed なメールボックス名の集合から 引数にマッチするものすべてを返します。
LIST コマンドを送り、active/subscribed なメールボックス名の集合から
引数にマッチするものすべてを返します。
詳しくは 2060 の 6.3.8 を参照してください。
返り値は Net::IMAP::MailboxList の配列で返します。
返り値が空集合である場合は空の配列でなく nil を返します。
@param refname 参照名(文字列)
@param mailbox 調べるメールボックスの名前(文字列)。ワイルドカードを含んでいてもかまいません。 -
Net
:: IMAP # rename(mailbox , newname) -> Net :: IMAP :: TaggedResponse (9322.0) -
RENAME コマンドを送り、指定したメールボックスをリネームします。
RENAME コマンドを送り、指定したメールボックスをリネームします。
@param mailbox リネームするメールボックス(文字列)
@param newname リネーム後の名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
リネームできなかった場合に発生します。
指定した名前のメールボックスが存在しない場合や、
リネーム後の名前を持つメールボックスが既に存在する
場合に発生します。 -
Net
:: IMAP # subscribe(mailbox) -> Net :: IMAP :: TaggedResponse (9322.0) -
SUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合に 追加します。
SUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合に
追加します。
@param mailbox 追加するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
追加できなかった場合に発生します。
指定した名前のメールボックスが存在しない場合などに
生じます。 -
Net
:: IMAP # unsubscribe(mailbox) -> Net :: IMAP :: TaggedResponse (9322.0) -
UNSUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合から 削除します。
UNSUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合から
削除します。
@param mailbox 削除するするメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
削除できなかった場合に発生します。
指定した名前のメールボックスが active/subscribe でなかった
場合などに発生します。 -
Net
:: IMAP :: BodyTypeBasic # disposition -> Net :: IMAP :: ContentDisposition | nil (9322.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMessage # disposition -> Net :: IMAP :: ContentDisposition | nil (9322.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMultipart # disposition -> Net :: IMAP :: ContentDisposition | nil (9322.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeText # disposition -> Net :: IMAP :: ContentDisposition | nil (9322.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: ResponseText # code -> Net :: IMAP :: ResponseCode | nil (9322.0) -
レスポンスコードを返します。
レスポンスコードを返します。
応答がレスポンスコードを含んでいない場合は nil を返します。
@see Net::IMAP::ResponseCode -
Net
:: IMAP :: TaggedResponse # data -> Net :: IMAP :: ResponseText (9322.0) -
レスポンスを解析したオブジェクトを返します。
レスポンスを解析したオブジェクトを返します。
@see Net::IMAP::ResponseText -
Net
:: IMAP # check -> Net :: IMAP :: TaggedResponse (9304.0) -
CHECK コマンドを送り、現在処理しているメールボックスの チェックポイントを要求します。
CHECK コマンドを送り、現在処理しているメールボックスの
チェックポイントを要求します。
チェックポイントの要求とは、サーバ内部で保留状態になっている
操作を完了させることを意味します。例えばメモリ上にあるメールの
データをディスクに書き込むため、fsyncを呼んだりすることです。
実際に何が行なわれるかはサーバの実装によりますし、何も行なわれない
場合もあります。 -
Net
:: IMAP # close -> Net :: IMAP :: TaggedResponse (9304.0) -
CLOSE コマンドを送り、処理中のメールボックスを閉じます。
CLOSE コマンドを送り、処理中のメールボックスを閉じます。
このコマンドによって、どのメールボックスも選択されていない
状態に移行します。
そして \Deleted フラグが付けられたメールがすべて削除されます。 -
Net
:: IMAP # greeting -> Net :: IMAP :: UntaggedResponse (9304.0) -
サーバから最初に送られてくるメッセージ(greeting message) を返します。
サーバから最初に送られてくるメッセージ(greeting message)
を返します。 -
Net
:: IMAP # logout -> Net :: IMAP :: TaggedResponse (9304.0) -
LOGOUT コマンドを送り、コネクションを切断することを サーバに伝えます。
LOGOUT コマンドを送り、コネクションを切断することを
サーバに伝えます。 -
Net
:: IMAP # noop -> Net :: IMAP :: TaggedResponse (9304.0) -
NOOP コマンドを送ります。
NOOP コマンドを送ります。
このコマンドは何もしません。 -
Net
:: IMAP :: BodyTypeMessage # envelope -> Net :: IMAP :: Envelpe | nil (9304.0) -
メッセージのエンベロープを返します。
メッセージのエンベロープを返します。 -
Net
:: IMAP :: ContinuationRequest # data -> Net :: IMAP :: ResponseText (9304.0) -
レスポンスのデータを返します。
レスポンスのデータを返します。 -
Net
:: IMAP :: ThreadMember # children -> [Net :: IMAP :: ThreadMember] (9304.0) -
スレッドの木構造における自身の下位の部分を返します。
スレッドの木構造における自身の下位の部分を返します。 -
Net
:: IMAP :: FetchData # attr -> { String => object } (9199.0) -
各メッセージのアトリビュートの値をハッシュテーブルで返します。
各メッセージのアトリビュートの値をハッシュテーブルで返します。
キーはアトリビュート名の文字列、値はアトリビュートの値となります。
値のクラスはアトリビュートによって異なります。
利用可能なアトリビュートは以下の通りです。
: BODY
BODYSTRUCTURE の拡張データなしの形式。
Net::IMAP::BodyTypeBasic, Net::IMAP::BodyTypeText,
Net::IMAP::BodyTypeMessage, Net::IMAP::BodyTypeMultipart
のいずれか。
: BODY[<section>]<<... -
Net
:: IMAP :: BodyTypeBasic (9145.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 :: MailboxList (9145.0) -
Net::IMAP#list、Net::IMAP#xlist、Net::IMAP#lsub で返されるメールボックスのデータを表します。
Net::IMAP#list、Net::IMAP#xlist、Net::IMAP#lsub
で返されるメールボックスのデータを表します。 -
Net
:: IMAP # search(keys , charset = nil) -> [Integer] (9109.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 # sort(sort _ keys , search _ keys , charset) -> [Integer] (9109.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 _ search(keys , charset = nil) -> [Integer] (9109.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 _ sort(sort _ keys , search _ keys , charset) -> [Integer] (9109.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 . add _ authenticator(auth _ type , authenticator) -> () (9103.0) -
Net::IMAP#authenticate で使う 認証用クラスを設定します。
Net::IMAP#authenticate で使う
認証用クラスを設定します。
imap ライブラリに新たな認証方式を追加するために用います。
通常は使う必要はないでしょう。もしこれを用いて
認証方式を追加する場合は net/imap.rb の
Net::IMAP::LoginAuthenticator などを参考にしてください。
@param auth_type 認証の種類(文字列)
@param authenticator 認証クラス(Class オブジェクト) -
Net
:: IMAP :: MailboxQuota (9097.0) -
Net::IMAP#getquota や Net::IMAP#getquotaroot で得られる quota の情報を表すオブジェクトです。
Net::IMAP#getquota や Net::IMAP#getquotaroot で得られる
quota の情報を表すオブジェクトです。
詳しくは 2087 を参照してください。 -
Net
:: IMAP :: ThreadMember (9097.0) -
Net::IMAP#thread、 Net::IMAP#uid_thread から 得られるスレッドの木構造のノードを表すクラスです。
Net::IMAP#thread、 Net::IMAP#uid_thread から
得られるスレッドの木構造のノードを表すクラスです。 -
Net
:: IMAP . format _ date(time) -> String (9085.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 (9085.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 :: TaggedResponse (9085.0) -
IMAP のタグ付きレスポンスを表すクラスです。
IMAP のタグ付きレスポンスを表すクラスです。
IMAP のレスポンスにはタグ付きのものとタグなしのものがあり、
タグ付きのレスポンスはクライアントが発行したコマンドによる
操作が成功するか失敗するかのどちらかで
完了したことを意味します。タグによって
どのコマンドが完了したのかを示します。
@see Net::IMAP::UntaggedResponse -
Net
:: IMAP :: UntaggedResponse (9085.0) -
IMAP のタグ付きレスポンスを表すクラスです。
IMAP のタグ付きレスポンスを表すクラスです。
IMAP のレスポンスにはタグ付きのものとタグなしのものがあり、
タグなしのものはクライアントからのコマンド完了応答ではない
レスポンスです。
@see Net::IMAP::TaggedResponse -
Net
:: IMAP # add _ response _ handler(handler) -> () (9073.0) -
レスポンスハンドラを追加します。
レスポンスハンドラを追加します。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。
レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_respo... -
Net
:: IMAP # add _ response _ handler(handler) {|resp| . . . } -> () (9073.0) -
レスポンスハンドラを追加します。
レスポンスハンドラを追加します。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。
レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_respo... -
Net
:: IMAP :: FetchData (9073.0) -
FETCH コマンドの応答を表すクラスです。
FETCH コマンドの応答を表すクラスです。
Net::IMAP#fetch、Net::IMAP#uid_fetch、
Net::IMAP#store、Net::IMAP#uid_store の
返り値として利用されます。 -
Net
:: IMAP :: ContinuationRequest (9067.0) -
IMAP の continuation request (命令継続要求) を表すクラスです。
IMAP の continuation request (命令継続要求) を表すクラスです。
通常このクラスを直接扱うことはありません。
レスポンスハンドラ(Net::IMAP#add_response_handler)
に渡されます。
詳しくは 2060 の 7.5 を参照してください。 -
Net
:: IMAP # capability -> [String] (9055.0) -
CAPABILITY コマンドを送ってサーバがサポートしている 機能(capabilities)のリストを文字列の配列として返します。
CAPABILITY コマンドを送ってサーバがサポートしている
機能(capabilities)のリストを文字列の配列として返します。
capability は IMAP に関連する RFC などで定義されています。
imap.capability
# => ["IMAP4REV1", "UNSELECT", "IDLE", "NAMESPACE", "QUOTA", ... ] -
Net
:: IMAP # responses -> { String => [object] } (9055.0) -
サーバから送られてきた untagged な応答の記録を返します。
サーバから送られてきた untagged な応答の記録を返します。
untagged な応答は種類ごとに記録されます。
応答の種類には "FLAGS", "OK", "UIDVALIDITY", "EXISTS" などがあり、
この文字列がハッシュテーブルのキーとなります。
そして各種類ごとに配列が用意され、untagged な応答を受信するたびに
その配列の末尾にその内容が記録されます。
例:
imap.select("inbox")
p imap.responses["EXISTS"].last
#=> 2
p imap.responses["UIDVALIDITY"... -
Net
:: IMAP . decode _ utf7(str) -> String (9055.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 . encode _ utf7(str) -> String (9055.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 :: ResponseError (9055.0) -
サーバからのレスポンスがエラーを示している場合に発生する例外 のクラスです。
サーバからのレスポンスがエラーを示している場合に発生する例外
のクラスです。
実際にはこれを継承した
* Net::IMAP::NoResponseError
* Net::IMAP::BadResponseError
* Net::IMAP::ByeResponseError
これらのクラスの例外が発生します。 -
Net
:: IMAP # idle _ done -> () (9049.0) -
Net::IMAP#idle で 停止しているスレッドを1つ起こします。
Net::IMAP#idle で
停止しているスレッドを1つ起こします。 -
Net
:: IMAP :: BadResponseError (9049.0) -
サーバから "BAD" レスポンスが来た場合に発生する例外のクラスです。 クライアントからのコマンドが IMAP の規格から外れている場合や サーバ内部エラーの場合に発生します。
サーバから "BAD" レスポンスが来た場合に発生する例外のクラスです。
クライアントからのコマンドが IMAP の規格から外れている場合や
サーバ内部エラーの場合に発生します。 -
Net
:: IMAP :: Error (9049.0) -
すべての IMAP 例外クラスのスーパークラス。
すべての IMAP 例外クラスのスーパークラス。 -
Net
:: IMAP :: MailboxQuotaRoot (9049.0) -
Net::IMAP#getquotaroot の結果として得られる quota root 情報を表わすオブジェクトです。
Net::IMAP#getquotaroot の結果として得られる
quota root 情報を表わすオブジェクトです。
詳しくは 2087 を参照してください。 -
Net
:: IMAP # status(mailbox , attr) -> {String => Integer} (9037.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 . max _ flag _ count -> Integer (9037.0) -
サーバからのレスポンスに含まれる flag の上限を返します。
サーバからのレスポンスに含まれる flag の上限を返します。
これを越えた flag がレスポンスに含まれている場合は、
Net::IMAP::FlagCountError 例外が発生します。
@see Net::IMAP.max_flag_count= -
Net
:: IMAP . max _ flag _ count=(count) (9037.0) -
サーバからのレスポンスに含まれる flag の上限を設定します。
サーバからのレスポンスに含まれる flag の上限を設定します。
これを越えた flag がレスポンスに含まれている場合は、
Net::IMAP::FlagCountError 例外が発生します。
デフォルトは 10000 です。通常は変える必要はないでしょう。
@param count 設定する最大値の整数
@see Net::IMAP.max_flag_count -
Net
:: IMAP :: FetchData # seqno -> Integer (9037.0) -
メッセージの sequence number を返します。
メッセージの sequence number を返します。
Net::IMAP#uid_fetch、Net::IMAP#uid_storeであっても
UID ではなく、sequence numberを返します。 -
Net
:: IMAP :: MARKED -> Symbol (9037.0) -
「:Marked」というシンボルを返します。
「:Marked」というシンボルを返します。
メールボックスが「interesting」であるとサーバによって
印付けられていることを意味します。通常メールボックスに
新しいメールが届いていることを意味します。
LIST応答の属性
(Net::IMAP#list、Net::IMAP::MailboxList#attr)
として用いられます。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: NOINFERIORS -> Symbol (9037.0) -
「:Noinferiors」というシンボルを返します。
「:Noinferiors」というシンボルを返します。
このメールボックスの
下に子レベルの階層が存在不可能であることを意味します。
LIST応答の属性
(Net::IMAP#list、Net::IMAP::MailboxList#attr)
として用いられます。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: NOSELECT -> Symbol (9037.0) -
「:Noselect」というシンボルを返します。
「:Noselect」というシンボルを返します。
メールボックスが選択可能でないことを意味します。
LIST応答の属性
(Net::IMAP#list、Net::IMAP::MailboxList#attr)
として用いられます。
詳しくは 2060 を参照してください。 -
Net
:: IMAP :: UNMARKED -> Symbol (9037.0) -
「:Unmarked」というシンボルを返します。
「:Unmarked」というシンボルを返します。
メールボックスが
印付けられていないことを意味します。
メールボックスに新しいメールが届いていないことを意味します。
LIST応答の属性
(Net::IMAP#list、Net::IMAP::MailboxList#attr)
として用いられます。
詳しくは 2060 を参照してください。 -
Net
:: IMAP # disconnect -> nil (9019.0) -
サーバとの接続を切断します。
サーバとの接続を切断します。
@see Net::IMAP#disconnected? -
Net
:: IMAP # disconnected? -> bool (9019.0) -
サーバとの接続が切断されていれば真を返します。
サーバとの接続が切断されていれば真を返します。
@see Net::IMAP#disconnect -
Net
:: IMAP # expunge -> [Integer] | nil (9019.0) -
EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを すべて処理中のメールボックスから削除します。
EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを
すべて処理中のメールボックスから削除します。
削除したメッセージの message sequence number を配列で返します。
@raise Net::IMAP::NoResponseError メールボックスが read-only である場合に発生します