検索結果

Net::IMAP#fetch(set, attr) -> [Net::IMAP::FetchData] (28207.0)

• 2.7.0

• インスタンスメソッド

FETCH コマンドを送り、メールボックス内のメッセージに 関するデータを取得します。

FETCH コマンドを送り、メールボックス内のメッセージに
関するデータを取得します。

Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを対象とします。

set で対象とするメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。
attr には取得するアトリビュートを文字列の配列で渡してください。
指定可能なアトリビュートについては Net::IMAP::FetchData#attr
を見てください。

例:

p imap....

• Net::IMAP
• Range

Net::IMAP#uid_fetch(set, attr) -> [Net::IMAP::FetchData] (28207.0)

• 2.7.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
• Range

Net::IMAP#getquotaroot(mailbox) -> [Net::IMAP::MailboxQuotaRoot | Net::IMAP::MailboxQuota] (27907.0)

• 2.7.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
• Net::IMAP::MailboxQuota
• Net::IMAP::MailboxQuotaRoot

Net::IMAP#getacl(mailbox) -> [Net::IMAP::MailboxACLItem] (27607.0)

• 2.7.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
• Net::IMAP::MailboxACLItem

Net::IMAP#getquota(mailbox) -> [Net::IMAP::MailboxQuota] (27607.0)

• 2.7.0

• インスタンスメソッド

GETQUOTA コマンドを送って 指定したメールボックスの quota の情報を返します。

GETQUOTA コマンドを送って
指定したメールボックスの quota の情報を返します。

quota の情報は Net::IMAP::MailboxQuota オブジェクトの配列で
得られます。

詳しくは 2087 を見てください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。

@param mailbox quota 情報を得たいメールボックス名
@raise Net::IMAP::NoResponseError 指定したメールボックスが quota root でない場合に発生します

• Net::IMAP
• Net::IMAP::MailboxQuota

絞り込み条件を変える

Net::IMAP#responses -> { String => [object] } (27607.0)

• 2.7.0

• インスタンスメソッド

サーバから送られてきた untagged な応答の記録を返します。

サーバから送られてきた untagged な応答の記録を返します。

untagged な応答は種類ごとに記録されます。
応答の種類には "FLAGS", "OK", "UIDVALIDITY", "EXISTS" などがあり、
この文字列がハッシュテーブルのキーとなります。
そして各種類ごとに配列が用意され、untagged な応答を受信するたびに
その配列の末尾にその内容が記録されます。


例:
imap.select("inbox")
p imap.responses["EXISTS"].last
#=> 2
p imap.responses["UIDVALIDITY"...

• Net::IMAP

Net::IMAP#setquota(mailbox, quota) -> Net::IMAP::TaggedResponse (27607.0)

• 2.7.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

Net::IMAP::ResponseText#code -> Net::IMAP::ResponseCode | nil (27607.0)

• 2.7.0

• インスタンスメソッド

レスポンスコードを返します。

レスポンスコードを返します。

応答がレスポンスコードを含んでいない場合は nil を返します。

@see Net::IMAP::ResponseCode

• Net::IMAP::ResponseCode
• Net::IMAP::ResponseText

Net::IMAP#delete(mailbox) -> Net::IMAP::TaggedResponse (27307.0)

• 2.7.0

• インスタンスメソッド

DELETE コマンドを送り、指定したメールボックスを削除します。

DELETE コマンドを送り、指定したメールボックスを削除します。

@param mailbox 削除するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを削除できなかった場合
に発生します。指定した名前のメールボックスが存在しない場合や、
ユーザにメールボックスを削除する権限がない場合に発生します。

• Net::IMAP

Net::IMAP#greeting -> Net::IMAP::UntaggedResponse (27307.0)

• 2.7.0

• インスタンスメソッド

サーバから最初に送られてくるメッセージ(greeting message) を返します。

サーバから最初に送られてくるメッセージ(greeting message)
を返します。

• Net::IMAP

絞り込み条件を変える

Net::IMAP#setacl(mailbox, user, rights) (27307.0)

• 2.7.0

• インスタンスメソッド

SETACL コマンドを送り、指定したメールボックスに 指定したユーザに関する権限を設定します。

SETACL コマンドを送り、指定したメールボックスに
指定したユーザに関する権限を設定します。

rights には設定する権限を表す文字列を指定します。
どのような文字列を指定すべきかは 2086 を参照してください。
rights に nil を渡すと、空文字列を指定したのと同様、つまり
すべての権限を削除します。

@param mailbox 権限を設定するメールボックスの名前(文字列)
@param user 権限を設定するユーザの名前(文字列)
@param rights 権限を表す文字列

• Net::IMAP

Net::IMAP.format_datetime(time) -> String (27307.0)

• 2.7.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

Net::IMAP::BodyTypeText#content_id -> String | nil (27307.0)

• 2.7.0

• インスタンスメソッド

Content-ID の値を文字列で返します。

Content-ID の値を文字列で返します。

@see 2045

• Net::IMAP::BodyTypeText

Net::IMAP::BodyTypeText#description -> String | nil (27307.0)

• 2.7.0

• インスタンスメソッド

Content-Description の値を文字列で返します。

Content-Description の値を文字列で返します。

@see 2045

• Net::IMAP::BodyTypeText

Net::IMAP::BodyTypeText#encoding -> String (27307.0)

• 2.7.0

• インスタンスメソッド

Content-Transfer-Encoding の値を文字列で返します。

Content-Transfer-Encoding の値を文字列で返します。

@see 2045

• Net::IMAP::BodyTypeText

絞り込み条件を変える

Net::IMAP::BodyTypeText#extension -> Array | nil (27307.0)

• 2.7.0

• インスタンスメソッド

メッセージの拡張データを返します。

メッセージの拡張データを返します。

• Net::IMAP::BodyTypeText

Net::IMAP::BodyTypeText#language -> String | [String] | nil (27307.0)

• 2.7.0

• インスタンスメソッド

1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。

1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。

• Net::IMAP::BodyTypeText

Net::IMAP::BodyTypeText#lines -> Integer (27307.0)

• 2.7.0

• インスタンスメソッド

ボディの行数を返します。

ボディの行数を返します。

• Net::IMAP::BodyTypeText

Net::IMAP::BodyTypeText#media_subtype -> String (27307.0)

• 2.7.0

• インスタンスメソッド

MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。

MIME のメディアタイプのサブタイプを返します。

media_subtype は obsolete です。

@see Net::IMAP::BodyTypeText#media_type

• Net::IMAP::BodyTypeText

Net::IMAP::BodyTypeText#media_type -> String (27307.0)

• 2.7.0

• インスタンスメソッド

MIME のメディアタイプを返します。

MIME のメディアタイプを返します。

これは "TEXT" を返します。

@see Net::IMAP::BodyTypeText#subtype

• Net::IMAP::BodyTypeText

絞り込み条件を変える

Net::IMAP::BodyTypeText#size -> Integer (27307.0)

• 2.7.0

• インスタンスメソッド

ボディのサイズのオクテット数を返します。

ボディのサイズのオクテット数を返します。

• Net::IMAP::BodyTypeText

Net::IMAP::BodyTypeText#subtype -> String (27307.0)

• 2.7.0

• インスタンスメソッド

MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。

MIME のメディアタイプのサブタイプを返します。

media_subtype は obsolete です。

@see Net::IMAP::BodyTypeText#media_type

• Net::IMAP::BodyTypeText

Net::IMAP::DELETED -> Symbol (27307.0)

• 2.7.0

• 定数

「:Deleted」というシンボルを返します。

「:Deleted」というシンボルを返します。

メッセージが削除されていることを意味します。
EXPUNGE で完全に除去されます。

フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。

詳しくは 2060 を参照してください。

• Net::IMAP

Net::IMAP::FetchData#seqno -> Integer (27307.0)

• 2.7.0

• インスタンスメソッド

メッセージの sequence number を返します。

メッセージの sequence number を返します。

Net::IMAP#uid_fetch、Net::IMAP#uid_storeであっても
UID ではなく、sequence numberを返します。

• Net::IMAP::FetchData

Net::IMAP::ResponseText#text -> String (27307.0)

• 2.7.0

• インスタンスメソッド

応答のテキストを文字列で返します。

応答のテキストを文字列で返します。

• Net::IMAP::ResponseText

絞り込み条件を変える

Net::IMAP::BodyTypeText (27007.0)

• 2.7.0

• クラス

Content-Type が text であるメッセージを表すクラスです。

Content-Type が text であるメッセージを表すクラスです。

平文のメールを表します。
詳しくは MIME のRFC(2045)を参照してください。

Net::IMAP::ByeResponseError (27007.0)

• 2.7.0

• クラス

サーバから "BYE" レスポンスが来た場合に発生する例外のクラスです。 ログインが拒否された場合や、クライアントが無反応で タイムアウトした場合に発生します。

サーバから "BYE" レスポンスが来た場合に発生する例外のクラスです。
ログインが拒否された場合や、クライアントが無反応で
タイムアウトした場合に発生します。

Net::IMAP::FetchData (27007.0)

• 2.7.0

• クラス

FETCH コマンドの応答を表すクラスです。

FETCH コマンドの応答を表すクラスです。

Net::IMAP#fetch、Net::IMAP#uid_fetch、
Net::IMAP#store、Net::IMAP#uid_store の
返り値として利用されます。

Net::IMAP::ResponseText (27007.0)

• 2.7.0

• クラス

応答のテキストを表すクラスです。

応答のテキストを表すクラスです。

Net::IMAP#thread(algorithm, search_keys, charset) -> [Net::IMAP::ThreadMember] (18907.0)

• 2.7.0

• インスタンスメソッド

THREADコマンドを送り、メールボックスを検索した結果を スレッド形式の木構造で返します。

THREADコマンドを送り、メールボックスを検索した結果を
スレッド形式の木構造で返します。

THREAD コマンドは 5256 で定義されています。
詳しくはそちらを参照してください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。

algorithm は木構造を決定するためのアルゴリズムを指定します。
以下の2つが利用可能です。
* "ORDEREDSUBJECT" subjectを使って平坦に区切るだけ
* "REFERENCES" どのメッセージに返事をしているかを見て木構造を作る
詳しくは 5256 を見てく...

• Net::IMAP
• Net::IMAP::ThreadMember

絞り込み条件を変える

Net::IMAP#uid_thread(algorithm, search_keys, charset) -> [Net::IMAP::ThreadMember] (18907.0)

• 2.7.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
• Net::IMAP::ThreadMember

Net::IMAP::ResponseError#response -> Net::IMAP::TaggedResponse | Net::IMAP::UntaggedResponse (18907.0)

• 2.7.0

• インスタンスメソッド

エラーとなったレスポンスを表すオブジェクトを返します。

エラーとなったレスポンスを表すオブジェクトを返します。

• Net::IMAP::ResponseError

Net::IMAP#add_response_handler(handler) {|resp| ...} -> () (18607.0)

• 2.7.0

• インスタンスメソッド

レスポンスハンドラを追加します。

レスポンスハンドラを追加します。

レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。

主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。

レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。

例:

imap.add_respo...

• Method
• Net::IMAP
• Net::IMAP::TaggedResponse
• Net::IMAP::UntaggedResponse
• Proc

Net::IMAP#close -> Net::IMAP::TaggedResponse (18607.0)

• 2.7.0

• インスタンスメソッド

CLOSE コマンドを送り、処理中のメールボックスを閉じます。

CLOSE コマンドを送り、処理中のメールボックスを閉じます。

このコマンドによって、どのメールボックスも選択されていない
状態に移行します。
そして \Deleted フラグが付けられたメールがすべて削除されます。

• Net::IMAP

Net::IMAP#idle {|resp| ...} -> Net::IMAP::TaggedResponse (18607.0)

• 2.7.0

• インスタンスメソッド

IDLE 命令を送り、メールボックスの非同期的変化を待ち受けます。

IDLE 命令を送り、メールボックスの非同期的変化を待ち受けます。

このメソッドに渡したブロックは
Net::IMAP#add_response_handler によって
レスポンスハンドラとして用いられます。
また、このメソッドが終了する時点で
Net::IMAP#remove_response_handler で
ハンドラが削除されます。

レスポンスハンドラについては
Net::IMAP#add_response_handler を参照してください。

別のスレッドが Net::IMAP#idle_done を呼びだすまで
このメソッドを呼びだしたスレッドは停止します。

この命令は ...

• Net::IMAP

絞り込み条件を変える

Net::IMAP.add_authenticator(auth_type, authenticator) -> () (18607.0)

• 2.7.0

• 特異メソッド

Net::IMAP#authenticate で使う 認証用クラスを設定します。

...追加するために用います。

通常は使う必要はないでしょう。もしこれを用いて
認証方式を追加する場合は net/imap.rb の
Net::IMAP::LoginAuthenticator などを参考にしてください。

@param auth_type 認証の種類(文字列)
@param authenticator 認...

• Net::IMAP

Net::IMAP::BodyTypeMessage#envelope -> Net::IMAP::Envelpe | nil (18607.0)

• 2.7.0

• インスタンスメソッド

メッセージのエンベロープを返します。

メッセージのエンベロープを返します。

• Net::IMAP::BodyTypeMessage

Net::IMAP::ResponseError#response=(resp) (18607.0)

• 2.7.0

• インスタンスメソッド

エラーとなったレスポンスを表すオブジェクトを設定します。

エラーとなったレスポンスを表すオブジェクトを設定します。

@param resp 設定するレスポンスオブジェクト

• Net::IMAP::ResponseError

Net::IMAP#add_response_handler(handler) -> () (18307.0)

• 2.7.0

• インスタンスメソッド

レスポンスハンドラを追加します。

レスポンスハンドラを追加します。

レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。

主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。

レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。

例:

imap.add_respo...

• Method
• Net::IMAP
• Net::IMAP::TaggedResponse
• Net::IMAP::UntaggedResponse
• Proc

Net::IMAP#append(mailbox, message, flags = nil, date_time = nil) -> Net::IMAP::TaggedResponse (18307.0)

• 2.7.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
• Symbol
• Time

絞り込み条件を変える

Net::IMAP#authenticate(auth_type, user, password) -> Net::IMAP::TaggedResponse (18307.0)

• 2.7.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

Net::IMAP#check -> Net::IMAP::TaggedResponse (18307.0)

• 2.7.0

• インスタンスメソッド

CHECK コマンドを送り、現在処理しているメールボックスの チェックポイントを要求します。

CHECK コマンドを送り、現在処理しているメールボックスの
チェックポイントを要求します。

チェックポイントの要求とは、サーバ内部で保留状態になっている
操作を完了させることを意味します。例えばメモリ上にあるメールの
データをディスクに書き込むため、fsyncを呼んだりすることです。
実際に何が行なわれるかはサーバの実装によりますし、何も行なわれない
場合もあります。

• Net::IMAP

Net::IMAP#client_thread -> Thread (18307.0)

• 2.7.0

• インスタンスメソッド

このメソッドは obsolete です。使わないでください。

このメソッドは obsolete です。使わないでください。

• Net::IMAP

Net::IMAP#client_thread=(th) (18307.0)

• 2.7.0

• インスタンスメソッド

このメソッドは obsolete です。使わないでください。

このメソッドは obsolete です。使わないでください。

• Net::IMAP

Net::IMAP#create(mailbox) -> Net::IMAP::TaggedResponse (18307.0)

• 2.7.0

• インスタンスメソッド

CREATE コマンドを送り、新しいメールボックスを作ります。

CREATE コマンドを送り、新しいメールボックスを作ります。

@param mailbox 新しいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスが作れなかった場合に発生します

• Net::IMAP

絞り込み条件を変える

Net::IMAP#disconnect -> nil (18307.0)

• 2.7.0

• インスタンスメソッド

サーバとの接続を切断します。

サーバとの接続を切断します。

@see Net::IMAP#disconnected?

• Net::IMAP

Net::IMAP#disconnected? -> bool (18307.0)

• 2.7.0

• インスタンスメソッド

サーバとの接続が切断されていれば真を返します。

サーバとの接続が切断されていれば真を返します。

@see Net::IMAP#disconnect

• Net::IMAP

Net::IMAP#examine(mailbox) -> Net::IMAP::TaggedResponse (18307.0)

• 2.7.0

• インスタンスメソッド

EXAMINE コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。

EXAMINE コマンドを送り、指定したメールボックスを処理対象の
メールボックスにします。

Net::IMAP#select と異なりセッション中はメールボックスが
読み取り専用となります。それ以外は select と同じです。

@param mailbox 処理対象としたいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError mailboxが存在しない等の理由でコマンドの実行に失敗
した場合に発生します。

• Net::IMAP

Net::IMAP#expunge -> [Integer] | nil (18307.0)

• 2.7.0

• インスタンスメソッド

EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを すべて処理中のメールボックスから削除します。

EXPUNGEコマンドを送り、:Deletedフラグをセットしたメッセージを
すべて処理中のメールボックスから削除します。

削除したメッセージの message sequence number を配列で返します。

@raise Net::IMAP::NoResponseError メールボックスが read-only である場合に発生します

• Net::IMAP

Net::IMAP#idle_done -> () (18307.0)

• 2.7.0

• インスタンスメソッド

Net::IMAP#idle で 停止しているスレッドを1つ起こします。

Net::IMAP#idle で
停止しているスレッドを1つ起こします。

• Net::IMAP

絞り込み条件を変える

Net::IMAP#move(set, mailbox) -> Net::IMAP::TaggedResponse (18307.0)

• 2.7.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
• Range

Net::IMAP#remove_response_handler(handler) -> () (18307.0)

• 2.7.0

• インスタンスメソッド

レスポンスハンドラを削除します。

レスポンスハンドラを削除します。

@param handler 削除するハンドラ
@see Net::IMAP#add_response_handler

• Net::IMAP

Net::IMAP#rename(mailbox, newname) -> Net::IMAP::TaggedResponse (18307.0)

• 2.7.0

• インスタンスメソッド

RENAME コマンドを送り、指定したメールボックスをリネームします。

RENAME コマンドを送り、指定したメールボックスをリネームします。

@param mailbox リネームするメールボックス(文字列)
@param newname リネーム後の名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
リネームできなかった場合に発生します。
指定した名前のメールボックスが存在しない場合や、
リネーム後の名前を持つメールボックスが既に存在する
場合に発生します。

• Net::IMAP

Net::IMAP#response_handlers -> Array (18307.0)

• 2.7.0

• インスタンスメソッド

設定されているレスポンスハンドラ全てを 配列で返します。

設定されているレスポンスハンドラ全てを
配列で返します。

@see Net::IMAP#add_response_handler

• Net::IMAP

Net::IMAP#search(keys, charset = nil) -> [Integer] (18307.0)

• 2.7.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

絞り込み条件を変える

Net::IMAP#select(mailbox) -> Net::IMAP::TaggedResponse (18307.0)

• 2.7.0

• インスタンスメソッド

SELECT コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。

SELECT コマンドを送り、指定したメールボックスを処理対象の
メールボックスにします。

このコマンドが成功すると、クライアントの状態が「selected」になります。

このコマンドを実行した直後に Net::IMAP#responses["EXISTS"].last
を調べると、メールボックス内のメールの数がわかります。
また、Net::IMAP#responses["RECENT"].lastで、
最新のメールの数がわかります。
これらの値はセッション中に変わりうることに注意してください。
Net::IMAP#add_response_handler を使うとそのような更新情報を
即...

• Net::IMAP

Net::IMAP#store(set, attr, flags) -> [Net::IMAP::FetchData] | nil (18307.0)

• 2.7.0

• インスタンスメソッド

STORE コマンドを送り、メールボックス内のメッセージを 更新します。

STORE コマンドを送り、メールボックス内のメッセージを
更新します。

set で更新するメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。

Net::IMAP#select で指定したメールボックスを対象とします。

attr で何をどのように変化させるかを指定します。
以下を指定することができます。
* "FLAGS"
* "+FLAGS"
* "-FLAGS"
それぞれメッセージのフラグの置き換え、追加、削除を意味します。
詳しくは 2060 の 6.4.6 を参考に...

• Net::IMAP
• Net::IMAP::FetchData
• Range
• Symbol

Net::IMAP#subscribe(mailbox) -> Net::IMAP::TaggedResponse (18307.0)

• 2.7.0

• インスタンスメソッド

SUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合に 追加します。

SUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合に
追加します。

@param mailbox 追加するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
追加できなかった場合に発生します。
指定した名前のメールボックスが存在しない場合などに
生じます。

• Net::IMAP

Net::IMAP#uid_move(set, mailbox) -> Net::IMAP::TaggedResponse (18307.0)

• 2.7.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
• Range

Net::IMAP#uid_search(keys, charset = nil) -> [Integer] (18307.0)

• 2.7.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

絞り込み条件を変える

Net::IMAP#uid_store(set, attr, flags) -> [Net::IMAP::FetchData] | nil (18307.0)

• 2.7.0

• インスタンスメソッド

UID STORE コマンドを送り、メールボックス内のメッセージを 更新します。

UID STORE コマンドを送り、メールボックス内のメッセージを
更新します。

set で更新するメッセージを指定します。
これには UID、UID の配列、もしくは
Range オブジェクトを渡します。

Net::IMAP#select で指定したメールボックスを対象とします。

attr で何をどのように変化させるかを指定します。
以下を指定することができます。
* "FLAGS"
* "+FLAGS"
* "-FLAGS"
それぞれメッセージのフラグの置き換え、追加、削除を意味します。
詳しくは 2060 の 6.4.6 を参考にしてください。

返り値は更新された内...

• Net::IMAP
• Net::IMAP::FetchData
• Range
• Symbol

Net::IMAP#unsubscribe(mailbox) -> Net::IMAP::TaggedResponse (18307.0)

• 2.7.0

• インスタンスメソッド

UNSUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合から 削除します。

UNSUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合から
削除します。

@param mailbox 削除するするメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
削除できなかった場合に発生します。
指定した名前のメールボックスが active/subscribe でなかった
場合などに発生します。

• Net::IMAP

Net::IMAP.debug -> bool (18307.0)

• 2.7.0

• 特異メソッド

デバッグモードが on になっていれば真を返します。

デバッグモードが on になっていれば真を返します。

@see Net::IMAP#debug=

• Net::IMAP

Net::IMAP.debug=(val) (18307.0)

• 2.7.0

• 特異メソッド

デバッグモードの on/off をします。

デバッグモードの on/off をします。

真を渡すと on になります。

@param val 設定するデバッグモードの on/off の真偽値
@see Net::IMAP#debug

• Net::IMAP

Net::IMAP.decode_utf7(str) -> String (18307.0)

• 2.7.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

絞り込み条件を変える

Net::IMAP.default_imap_port -> Integer (18307.0)

• 2.7.0

• 特異メソッド

デフォルトの IMAP のポート番号(143)を返します。

デフォルトの IMAP のポート番号(143)を返します。

@see Net::IMAP.default_tls_port

• Net::IMAP

Net::IMAP.default_imaps_port -> Integer (18307.0)

• 2.7.0

• 特異メソッド

デフォルトの IMAPS のポート番号(993)を返します。

デフォルトの IMAPS のポート番号(993)を返します。

@see Net::IMAP.default_port

• Net::IMAP

Net::IMAP.default_port -> Integer (18307.0)

• 2.7.0

• 特異メソッド

デフォルトの IMAP のポート番号(143)を返します。

デフォルトの IMAP のポート番号(143)を返します。

@see Net::IMAP.default_tls_port

• Net::IMAP

Net::IMAP.default_ssl_port -> Integer (18307.0)

• 2.7.0

• 特異メソッド

デフォルトの IMAPS のポート番号(993)を返します。

デフォルトの IMAPS のポート番号(993)を返します。

@see Net::IMAP.default_port

• Net::IMAP

Net::IMAP.default_tls_port -> Integer (18307.0)

• 2.7.0

• 特異メソッド

デフォルトの IMAPS のポート番号(993)を返します。

デフォルトの IMAPS のポート番号(993)を返します。

@see Net::IMAP.default_port

• Net::IMAP

絞り込み条件を変える

Net::IMAP.encode_utf7(str) -> String (18307.0)

• 2.7.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

Net::IMAP.format_date(time) -> String (18307.0)

• 2.7.0

• 特異メソッド

時刻オブジェクトを IMAP の日付フォーマットでの文字列に変換します。

...時刻オブジェクトを IMAP の日付フォーマットでの文字列に変換します。

require 'net/imap'

Net::IMAP.format_date(Time.new(2011, 6, 20))
# => "20-Jun-2011"

@param time 変換する時刻オブジェクト...

• Net::IMAP

Net::IMAP.new(host, options) -> Net::IMAP (18307.0)

• 2.7.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
• openssl

Net::IMAP.new(host, port = 143, usessl = false, certs = nil, verify = true) -> Net::IMAP (18307.0)

• 2.7.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
• openssl

Net::IMAP::ANSWERED -> Symbol (18307.0)

• 2.7.0

• 定数

「:Answered」というシンボルを返します。

「:Answered」というシンボルを返します。

そのメッセージに返答したことを意味します。

フラグメッセージ属性として用いられます
(Net::IMAP::FetchData#attr)。

詳しくは 2060 を参照してください。

• Net::IMAP

絞り込み条件を変える

Net::IMAP::Address#name -> String | nil (18307.0)

• 2.7.0

• インスタンスメソッド

メールアドレスの 822 の個人名(personal name)を返します。

メールアドレスの 822 の個人名(personal name)を返します。

個人名が存在しない場合は nil を返します。

通常は nil を返します。

• Net::IMAP::Address

Net::IMAP::Address#route -> String | nil (18307.0)

• 2.7.0

• インスタンスメソッド

メールアドレスの SMTP at-domain-list を返します。

メールアドレスの SMTP at-domain-list を返します。

存在しない場合は nil を返します。

通常は nil を返します。

• Net::IMAP::Address

Net::IMAP::BodyTypeBasic#content_id -> String | nil (18307.0)

• 2.7.0

• インスタンスメソッド

Content-ID の値を文字列で返します。

Content-ID の値を文字列で返します。

@see 2045

• Net::IMAP::BodyTypeBasic

Net::IMAP::BodyTypeBasic#description -> String | nil (18307.0)

• 2.7.0

• インスタンスメソッド

Content-Description の値を文字列で返します。

Content-Description の値を文字列で返します。

@see 2045

• Net::IMAP::BodyTypeBasic

Net::IMAP::BodyTypeBasic#encoding -> String (18307.0)

• 2.7.0

• インスタンスメソッド

Content-Transfer-Encoding の値を文字列で返します。

Content-Transfer-Encoding の値を文字列で返します。

@see 2045

• Net::IMAP::BodyTypeBasic

絞り込み条件を変える

Net::IMAP::BodyTypeBasic#extension -> Array | nil (18307.0)

• 2.7.0

• インスタンスメソッド

メッセージの拡張データを返します。

メッセージの拡張データを返します。

• Net::IMAP::BodyTypeBasic

Net::IMAP::BodyTypeBasic#language -> String | [String] | nil (18307.0)

• 2.7.0

• インスタンスメソッド

1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。

1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。

• Net::IMAP::BodyTypeBasic

Net::IMAP::BodyTypeBasic#media_subtype -> String (18307.0)

• 2.7.0

• インスタンスメソッド

MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。

MIME のメディアタイプのサブタイプを返します。

media_subtype は obsolete です。

@see Net::IMAP::BodyTypeBasic#media_type

• Net::IMAP::BodyTypeBasic

Net::IMAP::BodyTypeBasic#media_type -> String (18307.0)

• 2.7.0

• インスタンスメソッド

MIME のメディアタイプを返します。

MIME のメディアタイプを返します。

@see Net::IMAP::BodyTypeBasic#subtype

• Net::IMAP::BodyTypeBasic

Net::IMAP::BodyTypeBasic#size -> Integer (18307.0)

• 2.7.0

• インスタンスメソッド

ボディのサイズのオクテット数を返します。

ボディのサイズのオクテット数を返します。

• Net::IMAP::BodyTypeBasic

絞り込み条件を変える

Net::IMAP::BodyTypeBasic#subtype -> String (18307.0)

• 2.7.0

• インスタンスメソッド

MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。

MIME のメディアタイプのサブタイプを返します。

media_subtype は obsolete です。

@see Net::IMAP::BodyTypeBasic#media_type

• Net::IMAP::BodyTypeBasic

Net::IMAP::BodyTypeMessage#content_id -> String | nil (18307.0)

• 2.7.0

• インスタンスメソッド

Content-ID の値を文字列で返します。

Content-ID の値を文字列で返します。

@see 2045

• Net::IMAP::BodyTypeMessage

Net::IMAP::BodyTypeMessage#description -> String | nil (18307.0)

• 2.7.0

• インスタンスメソッド

Content-Description の値を文字列で返します。

Content-Description の値を文字列で返します。

@see 2045

• Net::IMAP::BodyTypeMessage

Net::IMAP::BodyTypeMessage#encoding -> String (18307.0)

• 2.7.0

• インスタンスメソッド

Content-Transfer-Encoding の値を文字列で返します。

Content-Transfer-Encoding の値を文字列で返します。

@see 2045

• Net::IMAP::BodyTypeMessage

Net::IMAP::BodyTypeMessage#extension -> Array | nil (18307.0)

• 2.7.0

• インスタンスメソッド

メッセージの拡張データを返します。

メッセージの拡張データを返します。

• Net::IMAP::BodyTypeMessage

絞り込み条件を変える

Net::IMAP::BodyTypeMessage#language -> String | [String] | nil (18307.0)

• 2.7.0

• インスタンスメソッド

1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。

1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。

• Net::IMAP::BodyTypeMessage

Net::IMAP::BodyTypeMessage#lines -> Integer (18307.0)

• 2.7.0

• インスタンスメソッド

ボディのテキストの行数を返します。

ボディのテキストの行数を返します。

• Net::IMAP::BodyTypeMessage

Net::IMAP::BodyTypeMessage#media_subtype -> String (18307.0)

• 2.7.0

• インスタンスメソッド

MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。

MIME のメディアタイプのサブタイプを返します。

media_subtype は obsolete です。

@see Net::IMAP::BodyTypeMessage#media_type

• Net::IMAP::BodyTypeMessage

Net::IMAP::BodyTypeMessage#media_type -> String (18307.0)

• 2.7.0

• インスタンスメソッド

MIME のメディアタイプを返します。

MIME のメディアタイプを返します。

これは "MESSAGE" を返します。

@see Net::IMAP::BodyTypeMessage#subtype

• Net::IMAP::BodyTypeMessage

Net::IMAP::BodyTypeMessage#size -> Integer (18307.0)

• 2.7.0

• インスタンスメソッド

ボディのサイズのオクテット数を返します。

ボディのサイズのオクテット数を返します。

• Net::IMAP::BodyTypeMessage

絞り込み条件を変える

Net::IMAP::BodyTypeMessage#subtype -> String (18307.0)

• 2.7.0

• インスタンスメソッド

MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。

MIME のメディアタイプのサブタイプを返します。

media_subtype は obsolete です。

@see Net::IMAP::BodyTypeMessage#media_type

• Net::IMAP::BodyTypeMessage

Net::IMAP::BodyTypeMultipart#extension -> Array | nil (18307.0)

• 2.7.0

• インスタンスメソッド

メッセージの拡張データを返します。

メッセージの拡張データを返します。

• Net::IMAP::BodyTypeMultipart

Net::IMAP::BodyTypeMultipart#language -> String | [String] | nil (18307.0)

• 2.7.0

• インスタンスメソッド

1766 で定義されているボディ言語を表わす 文字列もしくは文字列の配列を返します。

1766 で定義されているボディ言語を表わす
文字列もしくは文字列の配列を返します。

• Net::IMAP::BodyTypeMultipart

Net::IMAP::BodyTypeMultipart#media_subtype -> String (18307.0)

• 2.7.0

• インスタンスメソッド

MIME のメディアタイプのサブタイプを返します。 media_subtype は obsolete です。

MIME のメディアタイプのサブタイプを返します。

media_subtype は obsolete です。

@see 2045, Net::IMAP::BodyTypeText#media_type

• Net::IMAP::BodyTypeMultipart

Net::IMAP::BodyTypeMultipart#media_type -> String (18307.0)

• 2.7.0

• インスタンスメソッド

MIME のメディアタイプを返します。

MIME のメディアタイプを返します。

"MULTIPART" を返します。

@see Net::IMAP::BodyTypeMultipart#subtype

• Net::IMAP::BodyTypeMultipart

絞り込み条件を変える