Ruby 2.4.0 リファレンスマニュアル > ライブラリ一覧 > net/imapライブラリ > Net::IMAPクラス

class Net::IMAP

クラスの継承リスト: Net::IMAP < Object < Kernel < BasicObject

要約

IMAP 接続を表現するクラスです。

特異メソッド

定義 説明
add_authenticator(auth_type, authenticator) -> ()

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

debug -> bool

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

debug=(val)

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

decode_utf7(str) -> String

modified UTF-7 の文字列を UTF-8 の文字列に変換します。

default_port -> Integer
default_imap_port -> Integer

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

default_tls_port -> Integer
default_imaps_port -> Integer
default_ssl_port -> Integer

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

encode_utf7(str) -> String

UTF-8 の文字列を modified UTF-7 の文字列に変換します。

format_date(time) -> String

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

format_datetime(time) -> String

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

max_flag_count -> Integer

サーバからのレスポンスに含まれる flag の上限を返します。

max_flag_count=(count)

サーバからのレスポンスに含まれる flag の上限を設定します。

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

新たな Net::IMAP オブジェクトを生成し、指定したホストの指定したポートに接続し、接続語の IMAP オブジェクトを返します。

インスタンスメソッド

定義 説明
add_response_handler(handler) -> ()
add_response_handler(handler) {|resp| ...} -> ()

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

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

APPEND コマンドを送ってメッセージをメールボックスの末尾に追加します。

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

AUTHENTICATE コマンドを送り、クライアントを認証します。

capability -> [String]

CAPABILITY コマンドを送ってサーバがサポートしている機能(capabilities)のリストを文字列の配列として返します。

check -> Net::IMAP::TaggedResponse

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

client_thread -> Thread

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

client_thread=(th)

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

close -> Net::IMAP::TaggedResponse

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

copy(set, mailbox) -> Net::IMAP::TaggedResponse

COPY コマンドを送り、指定したメッセージを指定したメールボックスの末尾に追加します。

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

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

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

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

disconnect -> nil

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

disconnected? -> bool

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

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

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

expunge -> [Integer] | nil

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

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

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

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

GETACL コマンドを送り、メールボックスの ACL(Access Control List) を取得します。

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

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

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

GETQUOTAROOT コマンドを送って指定したメールボックスの quota root の一覧と、関連する quota の情報を返します。

greeting -> Net::IMAP::UntaggedResponse

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

idle {|resp| ...} -> Net::IMAP::TaggedResponse

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

idle_done -> ()

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

list(refname, mailbox) -> [Net::IMAP::MailboxList] | nil

LIST コマンドを送り、クライアントから利用可能なメールボックス名の集合から引数にマッチするものすべてを返します。

login(user, password) -> Net::IMAP::TaggedResponse

LOGIN コマンドを送り、平文でパスワードを送りクライアントユーザを認証します。

logout -> Net::IMAP::TaggedResponse

LOGOUT コマンドを送り、コネクションを切断することをサーバに伝えます。

lsub(refname, mailbox) -> [Net::IMAP::MailboxList]

LIST コマンドを送り、active/subscribed なメールボックス名の集合から引数にマッチするものすべてを返します。

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

MOVEコマンドを送り、set で指定したメッセージを mailbox の末尾に移動させます。

noop -> Net::IMAP::TaggedResponse

NOOP コマンドを送ります。

remove_response_handler(handler) -> ()

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

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

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

response_handlers -> Array

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

responses -> { String => [object] }

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

search(keys, charset = nil) -> [Integer]

SEARCH コマンドを送り、条件に合うメッセージの message sequence number を配列で返します。

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

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

setacl(mailbox, user, rights)

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

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

SETQUOTA コマンドを送り、指定したメールボックスに quota を設定します。

sort(sort_keys, search_keys, charset) -> [Integer]
uid_sort(sort_keys, search_keys, charset) -> [Integer]

SORT コマンド送り、メールボックス内のメッセージをソートした結果を返します。

starttls(options) -> Net::IMAP::TaggedResponse
starttls(certs, verify) -> Net::IMAP::TaggedResponse

STARTTLS コマンドを送って TLS のセッションを開始します。

status(mailbox, attr) -> {String => Integer}

STATUS コマンドを送り、mailbox のステータスを得ます。

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

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

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

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

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

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

uid_copy(set, mailbox) -> Net::IMAP::TaggedResponse

UID COPY コマンドを送り、指定したメッセージを指定したメールボックスの末尾に追加します。

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

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

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

MOVEコマンドを送り、set でUIDで指定したメッセージを mailbox の末尾に移動させます。

uid_search(keys, charset = nil) -> [Integer]

UID SEARCH コマンドを送り、条件に合うメッセージの UID を配列で返します。

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

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

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

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

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

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

xlist(refname, mailbox) -> [Net::IMAP::MailboxList]

XLISTコマンドを送り、クライアントから利用可能なメールボックス名の集合から引数にマッチするものすべてを返します。

定数

定義 説明
ANSWERED -> Symbol

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

DELETED -> Symbol

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

DRAFT -> Symbol

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

FLAGGED -> Symbol

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

MARKED -> Symbol

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

NOINFERIORS -> Symbol

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

NOSELECT -> Symbol

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

RECENT -> Symbol

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

SEEN -> Symbol

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

UNMARKED -> Symbol

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

継承したメソッド

! != __id__ __send__ instance_eval instance_exec method_missing singleton_method_added singleton_method_removed singleton_method_undefined !~ <=> == === =~ _dump class clone define_singleton_method display enum_for eql? equal? extend freeze frozen? hash initialize initialize_copy inspect instance_of? instance_variable_defined? instance_variable_get instance_variable_set instance_variables is_a? itself marshal_dump marshal_load method methods nil? object_id pretty_inspect pretty_print pretty_print_cycle pretty_print_inspect pretty_print_instance_variables private_methods protected_methods psych_to_yaml public_method public_methods public_send remove_instance_variable respond_to? respond_to_missing? send singleton_class singleton_method singleton_methods taint tainted? tap to_a to_ary to_hash to_int to_io to_proc to_regexp to_s to_str trust untaint untrust untrusted? .yaml_tag ::ARGF ::ARGV ::DATA ::ENV ::FALSE ::NIL ::RUBY_COPYRIGHT ::RUBY_DESCRIPTION ::RUBY_ENGINE ::RUBY_ENGINE_VERSION ::RUBY_PATCHLEVEL ::RUBY_PLATFORM ::RUBY_RELEASE_DATE ::RUBY_REVISION ::RUBY_VERSION ::SCRIPT_LINES__ ::STDERR ::STDIN ::STDOUT ::TOPLEVEL_BINDING ::TRUE