種類
- インスタンスメソッド (55)
- 特異メソッド (2)
クラス
-
Net
:: IMAP (13) -
Net
:: IMAP :: Address (4) -
Net
:: IMAP :: BodyTypeBasic (7) -
Net
:: IMAP :: BodyTypeMessage (8) -
Net
:: IMAP :: BodyTypeMultipart (3) -
Net
:: IMAP :: BodyTypeText (7) -
Net
:: IMAP :: ContentDisposition (1) -
Net
:: IMAP :: Envelope (10) -
Net
:: IMAP :: MailboxList (1) -
Net
:: IMAP :: ResponseCode (1) -
Net
:: IMAP :: ResponseText (1) -
Net
:: IMAP :: ThreadMember (1)
キーワード
- append (1)
- bcc (1)
- cc (1)
- code (1)
-
content
_ id (3) - data (1)
- date (1)
- delim (1)
- description (3)
- disconnect (1)
- disposition (4)
- envelope (1)
- expunge (1)
- extension (4)
- from (1)
- host (1)
-
in
_ reply _ to (1) - language (4)
- list (1)
- lsub (1)
- mailbox (1)
- md5 (3)
- name (1)
- new (2)
- param (4)
-
reply
_ to (1) - route (1)
- search (1)
- sender (1)
- seqno (1)
- setacl (1)
- setquota (1)
- store (1)
- subject (1)
- to (1)
-
uid
_ search (1) -
uid
_ store (1)
検索結果
先頭5件
-
Net
:: IMAP # append(mailbox , message , flags = nil , date _ time = nil) -> Net :: IMAP :: TaggedResponse (613.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 :: Address # mailbox -> String | nil (364.0) -
メールアドレスのメールボックス名を返します。
メールアドレスのメールボックス名を返します。
これが nil ならばそれは 822 group の終わりを意味します。
これが nil でなく、Net::IMAP::Address#mailbox が nil ならば、
822 のグループ名を表します。
どれでもなければ、822 の local-part を表します。
通常は、メールアドレスの「@」の手前を返します。 -
Net
:: IMAP :: Address # name -> String | nil (346.0) -
メールアドレスの 822 の個人名(personal name)を返します。
メールアドレスの 822 の個人名(personal name)を返します。
個人名が存在しない場合は nil を返します。
通常は nil を返します。 -
Net
:: IMAP :: Address # route -> String | nil (346.0) -
メールアドレスの SMTP at-domain-list を返します。
メールアドレスの SMTP at-domain-list を返します。
存在しない場合は nil を返します。
通常は nil を返します。 -
Net
:: IMAP # list(refname , mailbox) -> [Net :: IMAP :: MailboxList] | nil (328.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 . new(host , port = 143 , usessl = false , certs = nil , verify = true) -> Net :: IMAP (328.0) -
新たな Net::IMAP オブジェクトを生成し、指定したホストの 指定したポートに接続し、接続語の IMAP オブジェクトを返します。
...同じです。
これの :ssl パラメータを使うことで、OpenSSL のパラメータを詳細に
調整できます。
例
require 'net/imap'
imap = Net::IMAP.new('imap.example.com', :port => 993,
:ssl => { :verify_mode => OpenSSL::SSL::VERIFY_PEER,... -
Net
:: IMAP :: Address # host -> String | nil (328.0) -
メールアドレスのホスト名を返します。
メールアドレスのホスト名を返します。
nil は 822 のグループ文法に対応します。
これについては Net::IMAP::Address#mailbox も参照してください。
そうでない場合は 822 のドメイン名を表します。
通常は、メールアドレスの「@」の後ろのドメイン名を返します。 -
Net
:: IMAP :: Envelope # bcc -> [Net :: IMAP :: Address] | nil (328.0) -
Bcc を Net::IMAP::Address オブジェクトの配列で返します。
Bcc を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # cc -> [Net :: IMAP :: Address] | nil (328.0) -
Cc を Net::IMAP::Address オブジェクトの配列で返します。
Cc を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # date -> String | nil (328.0) -
日付の文字列を返します。
日付の文字列を返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # from -> [Net :: IMAP :: Address] | nil (328.0) -
From を Net::IMAP::Address オブジェクトの配列で返します。
From を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # in _ reply _ to -> String | nil (328.0) -
In-reply-to の内容を文字列で返します。
In-reply-to の内容を文字列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # message _ id -> String | nil (328.0) -
message_id を文字列で返します。
message_id を文字列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # reply _ to -> [Net :: IMAP :: Address] | nil (328.0) -
Reply-To を Net::IMAP::Address オブジェクトの配列で返します。
Reply-To を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # sender -> [Net :: IMAP :: Address] | nil (328.0) -
Sender を Net::IMAP::Address オブジェクトの配列で返します。
Sender を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # subject -> String | nil (328.0) -
メッセージのサブジェクトを返します。
メッセージのサブジェクトを返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: Envelope # to -> [Net :: IMAP :: Address] | nil (328.0) -
To を Net::IMAP::Address オブジェクトの配列で返します。
To を Net::IMAP::Address オブジェクトの配列で返します。
エンベロープに存在しないときは nil を返します。 -
Net
:: IMAP :: MailboxList # delim -> String|nil (328.0) -
階層区切り文字列を返します。
階層区切り文字列を返します。
まったく階層が存在しない場合は nil を返します。 -
Net
:: IMAP :: ResponseCode # data -> object | nil (328.0) -
レスポンスコードのデータを返します。
レスポンスコードのデータを返します。
レスポンスコードの種類によって返すオブジェクトは異なります。
ない場合は nil を返します。 -
Net
:: IMAP :: ResponseText # code -> Net :: IMAP :: ResponseCode | nil (328.0) -
レスポンスコードを返します。
レスポンスコードを返します。
応答がレスポンスコードを含んでいない場合は nil を返します。
@see Net::IMAP::ResponseCode -
Net
:: IMAP :: ThreadMember # seqno -> Integer | nil (328.0) -
メッセージの sequence number もしくは UID を返します。
メッセージの sequence number もしくは UID を返します。
root となるメッセージが存在しない場合しない木の場合は
nil を返します。 -
Net
:: IMAP # disconnect -> nil (310.0) -
サーバとの接続を切断します。
サーバとの接続を切断します。
@see Net::IMAP#disconnected? -
Net
:: IMAP # expunge -> [Integer] | nil (310.0) -
EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを すべて処理中のメールボックスから削除します。
EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを
すべて処理中のメールボックスから削除します。
削除したメッセージの message sequence number を配列で返します。
@raise Net::IMAP::NoResponseError メールボックスが read-only である場合に発生します -
Net
:: IMAP # search(keys , charset = nil) -> [Integer] (310.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 # store(set , attr , flags) -> [Net :: IMAP :: FetchData] | nil (310.0) -
STORE コマンドを送り、メールボックス内のメッセージを 更新します。
STORE コマンドを送り、メールボックス内のメッセージを
更新します。
set で更新するメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。
Net::IMAP#select で指定したメールボックスを対象とします。
attr で何をどのように変化させるかを指定します。
以下を指定することができます。
* "FLAGS"
* "+FLAGS"
* "-FLAGS"
それぞれメッセージのフラグの置き換え、追加、削除を意味します。
詳しくは 2060 の 6.4.6 を参考に... -
Net
:: IMAP # uid _ search(keys , charset = nil) -> [Integer] (310.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 _ store(set , attr , flags) -> [Net :: IMAP :: FetchData] | nil (310.0) -
UID STORE コマンドを送り、メールボックス内のメッセージを 更新します。
UID STORE コマンドを送り、メールボックス内のメッセージを
更新します。
set で更新するメッセージを指定します。
これには UID、UID の配列、もしくは
Range オブジェクトを渡します。
Net::IMAP#select で指定したメールボックスを対象とします。
attr で何をどのように変化させるかを指定します。
以下を指定することができます。
* "FLAGS"
* "+FLAGS"
* "-FLAGS"
それぞれメッセージのフラグの置き換え、追加、削除を意味します。
詳しくは 2060 の 6.4.6 を参考にしてください。
返り値は更新された内... -
Net
:: IMAP :: BodyTypeBasic # content _ id -> String | nil (310.0) -
Content-ID の値を文字列で返します。
Content-ID の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeBasic # description -> String | nil (310.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeBasic # disposition -> Net :: IMAP :: ContentDisposition | nil (310.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeBasic # extension -> Array | nil (310.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeBasic # language -> String | [String] | nil (310.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeBasic # md5 -> String | nil (310.0) -
ボディの MD5 値を文字列で返します。
ボディの MD5 値を文字列で返します。 -
Net
:: IMAP :: BodyTypeBasic # param -> { String => String } | nil (310.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # content _ id -> String | nil (310.0) -
Content-ID の値を文字列で返します。
Content-ID の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # description -> String | nil (310.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeMessage # disposition -> Net :: IMAP :: ContentDisposition | nil (310.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMessage # envelope -> Net :: IMAP :: Envelpe | nil (310.0) -
メッセージのエンベロープを返します。
メッセージのエンベロープを返します。 -
Net
:: IMAP :: BodyTypeMessage # extension -> Array | nil (310.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeMessage # language -> String | [String] | nil (310.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeMessage # md5 -> String | nil (310.0) -
ボディの MD5 値を文字列で返します。
ボディの MD5 値を文字列で返します。 -
Net
:: IMAP :: BodyTypeMessage # param -> { String => String } | nil (310.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: BodyTypeMultipart # disposition -> Net :: IMAP :: ContentDisposition | nil (310.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMultipart # extension -> Array | nil (310.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeMultipart # language -> String | [String] | nil (310.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeText # content _ id -> String | nil (310.0) -
Content-ID の値を文字列で返します。
Content-ID の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeText # description -> String | nil (310.0) -
Content-Description の値を文字列で返します。
Content-Description の値を文字列で返します。
@see 2045 -
Net
:: IMAP :: BodyTypeText # disposition -> Net :: IMAP :: ContentDisposition | nil (310.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeText # extension -> Array | nil (310.0) -
メッセージの拡張データを返します。
メッセージの拡張データを返します。 -
Net
:: IMAP :: BodyTypeText # language -> String | [String] | nil (310.0) -
1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。
1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。 -
Net
:: IMAP :: BodyTypeText # md5 -> String | nil (310.0) -
ボディの MD5 値を文字列で返します。
ボディの MD5 値を文字列で返します。 -
Net
:: IMAP :: BodyTypeText # param -> { String => String } | nil (310.0) -
MIME のボディパラメータをハッシュテーブルで返します。
MIME のボディパラメータをハッシュテーブルで返します。
ハッシュテーブルのキーがパラメータ名となります。
@see 2045 -
Net
:: IMAP :: ContentDisposition # param -> { String => String } | nil (310.0) -
Content-Disposition フィールドのパラメータをハッシュテーブルで 返します。
Content-Disposition フィールドのパラメータをハッシュテーブルで
返します。
ハッシュテーブルのキーは以下のような値を取ります。詳しくは
2183 などを見てください。
* "FILENAME"
* "CREATION-DATE"
* "MODIFICATION-DATE"
* "READ-DAT"
* "SIZE" -
Net
:: IMAP # setquota(mailbox , quota) -> Net :: IMAP :: TaggedResponse (43.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 . new(host , options) -> Net :: IMAP (28.0) -
新たな Net::IMAP オブジェクトを生成し、指定したホストの 指定したポートに接続し、接続語の IMAP オブジェクトを返します。
...同じです。
これの :ssl パラメータを使うことで、OpenSSL のパラメータを詳細に
調整できます。
例
require 'net/imap'
imap = Net::IMAP.new('imap.example.com', :port => 993,
:ssl => { :verify_mode => OpenSSL::SSL::VERIFY_PEER,... -
Net
:: IMAP # lsub(refname , mailbox) -> [Net :: IMAP :: MailboxList] (25.0) -
LIST コマンドを送り、active/subscribed なメールボックス名の集合から 引数にマッチするものすべてを返します。
LIST コマンドを送り、active/subscribed なメールボックス名の集合から
引数にマッチするものすべてを返します。
詳しくは 2060 の 6.3.8 を参照してください。
返り値は Net::IMAP::MailboxList の配列で返します。
返り値が空集合である場合は空の配列でなく nil を返します。
@param refname 参照名(文字列)
@param mailbox 調べるメールボックスの名前(文字列)。ワイルドカードを含んでいてもかまいません。 -
Net
:: IMAP # setacl(mailbox , user , rights) (25.0) -
SETACL コマンドを送り、指定したメールボックスに 指定したユーザに関する権限を設定します。
SETACL コマンドを送り、指定したメールボックスに
指定したユーザに関する権限を設定します。
rights には設定する権限を表す文字列を指定します。
どのような文字列を指定すべきかは 2086 を参照してください。
rights に nil を渡すと、空文字列を指定したのと同様、つまり
すべての権限を削除します。
@param mailbox 権限を設定するメールボックスの名前(文字列)
@param user 権限を設定するユーザの名前(文字列)
@param rights 権限を表す文字列