ライブラリ
- ビルトイン (49)
- benchmark (1)
-
bigdecimal
/ ludcmp (1) - e2mmap (13)
- forwardable (4)
- matrix (9)
- mkmf (1)
-
net
/ imap (95) - psych (13)
- rake (3)
- resolv (1)
-
rexml
/ sax2listener (2) - set (2)
- socket (4)
-
syslog
/ logger (6) - tsort (4)
- win32ole (13)
クラス
- Array (8)
- Encoding (1)
- Enumerator (2)
-
Enumerator
:: Lazy (7) - Exception (1)
- IO (1)
- Matrix (6)
-
Net
:: IMAP (58) -
Net
:: IMAP :: BodyTypeBasic (8) -
Net
:: IMAP :: BodyTypeMessage (8) -
Net
:: IMAP :: BodyTypeMultipart (5) -
Net
:: IMAP :: BodyTypeText (8) -
Net
:: IMAP :: FetchData (1) -
Net
:: IMAP :: ResponseError (1) -
Net
:: IMAP :: ResponseText (1) -
Net
:: IMAP :: TaggedResponse (2) -
Net
:: IMAP :: UntaggedResponse (1) - Object (4)
-
ObjectSpace
:: WeakMap (2) -
Psych
:: Handler (1) -
Psych
:: Nodes :: Mapping (12) -
Rake
:: FileList (1) -
Resolv
:: DNS :: Resource :: IN :: WKS (1) - Set (2)
- Socket (2)
- String (2)
-
Syslog
:: Logger (6) -
Thread
:: Backtrace :: Location (4) - Vector (3)
-
WIN32OLE
_ TYPE (7) -
WIN32OLE
_ TYPELIB (2) -
WIN32OLE
_ VARIABLE (3)
モジュール
- Benchmark (1)
- Enumerable (15)
- Exception2MessageMapper (13)
- Forwardable (2)
- Kernel (3)
- LUSolve (1)
- Process (1)
-
REXML
:: SAX2Listener (2) - SingleForwardable (2)
-
Socket
:: Constants (2) - TSort (4)
キーワード
-
1
. 6 . 8から1 . 8 . 0への変更点(まとめ) (1) - == (1)
-
AI
_ V4MAPPED (2) -
AI
_ V4MAPPED _ CFG (2) - ANY (1)
- BLOCK (1)
- FLOW (1)
- Fail (2)
- Location (1)
- Raise (2)
- Ruby用語集 (1)
- TaggedResponse (1)
- UntaggedResponse (1)
-
WIN32OLE
_ METHOD (1) - [] (1)
- []= (1)
-
absolute
_ path (1) -
add
_ authenticator (1) -
add
_ response _ handler (2) - anchor (1)
- anchor= (1)
- append (1)
- attr (1)
- authenticate (1)
-
base
_ label (1) - bind (1)
- binwrite (1)
- bmbm (1)
-
caller
_ locations (2) -
chunk
_ while (1) - code (1)
- collect (7)
- collect! (3)
- collect2 (2)
-
collect
_ concat (1) -
content
_ id (3) - copy (1)
- create (1)
- data (1)
- debug (2)
- debug= (1)
-
decode
_ utf7 (1) -
def
_ delegators (2) -
def
_ exception (2) -
def
_ instance _ delegators (1) -
def
_ single _ delegators (1) -
default
_ event _ sources (1) -
default
_ imap _ port (1) -
default
_ imaps _ port (1) -
default
_ ole _ types (1) -
default
_ port (1) -
default
_ ssl _ port (1) -
default
_ tls _ port (1) - delete (1)
- description (3)
- disconnect (1)
- disconnected? (1)
- disposition (4)
- each (2)
-
each
_ strongly _ connected _ component _ from (4) -
encode
_ utf7 (1) - encoding (3)
-
end
_ prefix _ mapping (1) -
enum
_ for (2) - error (1)
- examine (1)
- expunge (1)
-
extend
_ object (1) - fail (1)
- fatal (1)
- fetch (1)
-
flat
_ map (1) -
format
_ date (1) -
format
_ datetime (1) - getacl (1)
- getquota (1)
- getquotaroot (1)
- getrlimit (1)
- grep (1)
-
grep
_ v (1) -
implemented
_ ole _ types (1) - implicit (1)
- implicit= (1)
- info (1)
- inspect (1)
-
install
_ files (1) - lazy (1)
- list (1)
-
locale
_ charmap (1) - login (1)
- lsub (1)
- lusolve (1)
- map! (3)
- map2 (1)
-
max
_ flag _ count (1) -
max
_ flag _ count= (1) -
media
_ subtype (4) -
media
_ type (4) - move (1)
- new (7)
-
ole
_ classes (2) -
ole
_ methods (1) -
ole
_ types (1) - param (4)
- pathmap (1)
-
pathmap
_ explode (1) -
pathmap
_ replace (1) - rake (1)
-
raw
_ data (2) -
remove
_ response _ handler (1) - rename (1)
- response= (1)
-
response
_ handlers (1) - search (1)
- select (1)
- setacl (1)
- setquota (1)
-
slice
_ after (2) -
slice
_ before (2) -
slice
_ when (1) - sort (1)
-
sort
_ by (2) -
source
_ ole _ types (1) -
start
_ mapping (1) -
start
_ prefix _ mapping (1) - starttls (2)
- status (1)
- store (1)
- style (1)
- style= (1)
- subscribe (1)
- subtype (4)
- sum (2)
- tag (1)
- tag= (1)
- thread (1)
-
to
_ enum (2) -
to
_ s (1) - tsort (1)
- typelibs (1)
-
uid
_ copy (1) -
uid
_ fetch (1) -
uid
_ move (1) -
uid
_ search (1) -
uid
_ sort (1) -
uid
_ store (1) -
uid
_ thread (1) - unknown (1)
- unsubscribe (1)
-
variable
_ kind (1) - varkind (1)
- visible? (1)
- warn (1)
- xlist (1)
検索結果
先頭5件
-
Enumerator
:: Lazy # map {|item| . . . } -> Enumerator :: Lazy (45442.0) -
Enumerable#map と同じですが、配列ではなくEnumerator::Lazy を返します。
Enumerable#map と同じですが、配列ではなくEnumerator::Lazy を返します。
@raise ArgumentError ブロックを指定しなかった場合に発生します。
//emlist[例][ruby]{
1.step.lazy.map{ |n| n % 3 == 0 }
# => #<Enumerator::Lazy: #<Enumerator::Lazy: #<Enumerator: 1:step>>:map>
1.step.lazy.collect{ |n| n.succ }.take(10).force
# => [2, 3, 4, 5, 6, 7, 8,... -
Array
# map -> Enumerator (45361.0) -
各要素に対してブロックを評価した結果を全て含む配列を返します。
各要素に対してブロックを評価した結果を全て含む配列を返します。
ブロックを省略した場合は Enumerator を返します。
//emlist[例][ruby]{
# すべて 3 倍にする
p [1, 2, 3].map {|n| n * 3 } # => [3, 6, 9]
//}
@see Enumerable#collect, Enumerable#map -
Array
# map {|item| . . . } -> [object] (45361.0) -
各要素に対してブロックを評価した結果を全て含む配列を返します。
各要素に対してブロックを評価した結果を全て含む配列を返します。
ブロックを省略した場合は Enumerator を返します。
//emlist[例][ruby]{
# すべて 3 倍にする
p [1, 2, 3].map {|n| n * 3 } # => [3, 6, 9]
//}
@see Enumerable#collect, Enumerable#map -
Enumerable
# map -> Enumerator (45361.0) -
各要素に対してブロックを評価した結果を全て含む配列を返します。
各要素に対してブロックを評価した結果を全て含む配列を返します。
ブロックを省略した場合は Enumerator を返します。
//emlist[例][ruby]{
# すべて 3 倍にした配列を返す
p (1..3).map {|n| n * 3 } # => [3, 6, 9]
p (1..3).collect { "cat" } # => ["cat", "cat", "cat"]
//}
@see Array#collect, Array#map -
Enumerable
# map {|item| . . . } -> [object] (45361.0) -
各要素に対してブロックを評価した結果を全て含む配列を返します。
各要素に対してブロックを評価した結果を全て含む配列を返します。
ブロックを省略した場合は Enumerator を返します。
//emlist[例][ruby]{
# すべて 3 倍にした配列を返す
p (1..3).map {|n| n * 3 } # => [3, 6, 9]
p (1..3).collect { "cat" } # => ["cat", "cat", "cat"]
//}
@see Array#collect, Array#map -
Matrix
# map -> Enumerator (45343.0) -
行列の各要素に対してブロックの適用を繰り返した結果を、要素として持つ行列を生成します。
行列の各要素に対してブロックの適用を繰り返した結果を、要素として持つ行列を生成します。
ブロックがない場合、 Enumerator を返します。
//emlist[例][ruby]{
require 'matrix'
m = Matrix[[1, 2], [3, 4]]
p m.map { |x| x + 100 } # => Matrix[[101, 102], [103, 104]]
//}
@see Matrix#each -
Matrix
# map {|x| . . . } -> Matrix (45343.0) -
行列の各要素に対してブロックの適用を繰り返した結果を、要素として持つ行列を生成します。
行列の各要素に対してブロックの適用を繰り返した結果を、要素として持つ行列を生成します。
ブロックがない場合、 Enumerator を返します。
//emlist[例][ruby]{
require 'matrix'
m = Matrix[[1, 2], [3, 4]]
p m.map { |x| x + 100 } # => Matrix[[101, 102], [103, 104]]
//}
@see Matrix#each -
Net
:: IMAP . default _ imap _ port -> Integer (27319.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 -
Psych
:: Handler # start _ mapping(anchor , tag , implicit , style) -> () (18499.0) -
mapping の開始を見付けたときに呼び出されます。
mapping の開始を見付けたときに呼び出されます。
anchor には map に関連付けられた anchor の名前が文字列で渡されます。
anchor がない場合には nil が渡されます。
tag には map に関連付けられた tag の名前が文字列で渡されます。
tag がない場合には nil が渡されます。
implicit には map が implicit に開始されたかどうかが
真偽値で渡されます。
style には sequence の style が整数値で渡されます。以下のいずれか
です。
* Psych::Nodes::Mapping::BLOCK
... -
Vector
# map2(v) {|x , y| . . . } -> Vector (18394.0) -
ベクトルの各要素と引数 v の要素との組に対してブロックを評価し、その結果を要素として持つベクトルを返します。
ベクトルの各要素と引数 v の要素との組に対してブロックを評価し、その結果を要素として持つベクトルを返します。
ベクトルの各要素と、それに対応するインデックスを持つ引数 (ベクトル or 配列) の要素との組に対して (2引数の) ブロックを評価した結果を、要素として持つベクトルを返します。
ブロックを省略した場合は Enumerator を返します。
@param v ブロック内で評価される(ベクトル or 配列)
@raise ExceptionForMatrix::ErrDimensionMismatch 自分自身と引数のベクト
ルの要素の数(次元)が異なっていた... -
REXML
:: SAX2Listener # start _ prefix _ mapping(prefix , uri) -> () (18337.0) -
名前空間の接頭辞(prefix)が導入されたときに呼び出される コールバックメソッドです。
名前空間の接頭辞(prefix)が導入されたときに呼び出される
コールバックメソッドです。
以下のようなXMLを処理
<a xmlns:foo="http://foo.example.org/">
<foo:b />
</a>
すると
start_prefix_mapping("foo", "http://foo.example.org/")
start_element(nil, "a", "a", {"xmlns:foo" => "http://foo.example.org/"})
:
end_element(nil, "a", "a")
end_... -
Encoding
. locale _ charmap -> String | nil (18319.0) -
ロケールエンコーディングを決定するために用いる、locale charmap 名を返します。nl_langinfo 等がない環境では nil を、miniruby では ASCII_8BIT を返します。
ロケールエンコーディングを決定するために用いる、locale charmap 名を返します。nl_langinfo 等がない環境では nil を、miniruby では ASCII_8BIT を返します。
//emlist[Debian GNU/Linux + LANG=C][ruby]{
Encoding.locale_charmap #=> "ANSI_X3.4-1968"
//}
//emlist[LANG=ja_JP.EUC-JP][ruby]{
Encoding.locale_charmap #=> "EUC-JP"
//}
//emlist[SunOS 5 + LANG=C]... -
REXML
:: SAX2Listener # end _ prefix _ mapping(prefix) -> () (18319.0) -
名前空間の接頭辞(prefix)の適用範囲が終了したときに 呼び出されるコールバックメソッドです。
名前空間の接頭辞(prefix)の適用範囲が終了したときに
呼び出されるコールバックメソッドです。
@param prefix 接頭辞の文字列が渡されます -
Rake
:: FileList # pathmap(spec = nil) -> Rake :: FileList (18319.0) -
各要素に String#pathmap を適用した新しい Rake::FileList を返します。
各要素に String#pathmap を適用した新しい Rake::FileList を返します。
//emlist[][ruby]{
# Rakefile での記載例とする
task default: :test_rake_app
task :test_rake_app do
file_list = FileList.new("test1.rb", "test2.rb", "test3.rb")
file_list.pathmap("%n") # => ["test1", "test2", "test3"]
end
//}
@see String#pathmap -
Socket
:: AI _ V4MAPPED -> Integer (18319.0) -
Accept IPv4-mapped IPv6 addresses。
Accept IPv4-mapped IPv6 addresses。
Socket.getaddrinfo, Addrinfo.getaddrinfo の引数 flags に渡す
定数です。
@see getaddrinfo(3) -
Socket
:: AI _ V4MAPPED _ CFG -> Integer (18319.0) -
Accept IPv4 mapped addresses if the kernel supports it。
Accept IPv4 mapped addresses if the kernel supports it。
Socket.getaddrinfo, Addrinfo.getaddrinfo の引数 flags に渡す
定数です。
@see getipnodebyname(3freebsd) -
Socket
:: Constants :: AI _ V4MAPPED -> Integer (18319.0) -
Accept IPv4-mapped IPv6 addresses。
Accept IPv4-mapped IPv6 addresses。
Socket.getaddrinfo, Addrinfo.getaddrinfo の引数 flags に渡す
定数です。
@see getaddrinfo(3) -
Socket
:: Constants :: AI _ V4MAPPED _ CFG -> Integer (18319.0) -
Accept IPv4 mapped addresses if the kernel supports it。
Accept IPv4 mapped addresses if the kernel supports it。
Socket.getaddrinfo, Addrinfo.getaddrinfo の引数 flags に渡す
定数です。
@see getipnodebyname(3freebsd) -
String
# pathmap _ explode -> Array (18319.0) -
自身をパスを表す部分ごとに分解して配列にして返します。 String#pathmap で利用される protected メソッドです。
自身をパスを表す部分ごとに分解して配列にして返します。
String#pathmap で利用される protected メソッドです。
@see String#pathmap -
String
# pathmap _ replace(patterns) { . . . } -> String (18319.0) -
与えられたパスを前もって置き換えます。
与えられたパスを前もって置き換えます。
@param patterns 'pat1,rep1;pat2,rep2;...' のような形式で置換パターンを指定します。 -
Net
:: IMAP . default _ port -> Integer (18019.0) -
デフォルトの IMAP のポート番号(143)を返します。
デフォルトの IMAP のポート番号(143)を返します。
@see Net::IMAP.default_tls_port -
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 # getquotaroot(mailbox) -> [Net :: IMAP :: MailboxQuotaRoot | Net :: IMAP :: MailboxQuota] (9637.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 # append(mailbox , message , flags = nil , date _ time = nil) -> Net :: IMAP :: TaggedResponse (9427.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 . new(host , options) -> Net :: IMAP (9409.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 (9409.0) -
新たな Net::IMAP オブジェクトを生成し、指定したホストの 指定したポートに接続し、接続語の IMAP オブジェクトを返します。
新たな Net::IMAP オブジェクトを生成し、指定したホストの
指定したポートに接続し、接続語の IMAP オブジェクトを返します。
usessl が真ならば、サーバに繋ぐのに SSL/TLS を用います。
SSL/TLS での接続には OpenSSL と openssl が使える必要があります。
certs は利用する証明書のファイル名もしくは証明書があるディレクトリ名を
文字列で渡します。
certs に nil を渡すと、OpenSSL のデフォルトの証明書を使います。
verify は接続先を検証するかを真偽値で設定します。
真が OpenSSL::SSL::VERIFY_PE... -
Enumerator
:: Lazy # flat _ map {|item| . . . } -> Enumerator :: Lazy (9394.0) -
ブロックの実行結果をひとつに繋げたものに対してイテレートするような Enumerator::Lazy のインスタンスを返します。
ブロックの実行結果をひとつに繋げたものに対してイテレートするような
Enumerator::Lazy のインスタンスを返します。
//emlist[][ruby]{
["foo", "bar"].lazy.flat_map {|i| i.each_char.lazy}.force
#=> ["f", "o", "o", "b", "a", "r"]
//}
ブロックの返した値 x は、以下の場合にのみ分解され、連結されます。
* x が配列であるか、to_ary メソッドを持つとき
* x が each および force メソッドを持つ (例:Enumerator::Lazy) ... -
Array
# map! -> Enumerator (9379.0) -
各要素を順番にブロックに渡して評価し、その結果で要素を 置き換えます。
各要素を順番にブロックに渡して評価し、その結果で要素を
置き換えます。
ブロックが与えられなかった場合は、自身と map! から生成した
Enumerator オブジェクトを返します。
//emlist[例][ruby]{
ary = [1, 2, 3]
ary.map! {|i| i * 3 }
p ary #=> [3, 6, 9]
ary = [1, 2, 3]
e = ary.map!
e.each{ 1 }
p ary #=> [1, 1, 1]
//}
@see Array#collect, Enumerator -
Array
# map! {|item| . . } -> self (9379.0) -
各要素を順番にブロックに渡して評価し、その結果で要素を 置き換えます。
各要素を順番にブロックに渡して評価し、その結果で要素を
置き換えます。
ブロックが与えられなかった場合は、自身と map! から生成した
Enumerator オブジェクトを返します。
//emlist[例][ruby]{
ary = [1, 2, 3]
ary.map! {|i| i * 3 }
p ary #=> [3, 6, 9]
ary = [1, 2, 3]
e = ary.map!
e.each{ 1 }
p ary #=> [1, 1, 1]
//}
@see Array#collect, Enumerator -
Net
:: IMAP # authenticate(auth _ type , user , password) -> Net :: IMAP :: TaggedResponse (9373.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 # login(user , password) -> Net :: IMAP :: TaggedResponse (9373.0) -
LOGIN コマンドを送り、平文でパスワードを送りクライアント ユーザを認証します。
LOGIN コマンドを送り、平文でパスワードを送りクライアント
ユーザを認証します。
Net::IMAP#authenticate で "LOGIN" を使うのとは異なる
ことに注意してください。authenticate では AUTHENTICATE コマンドを
送ります。
認証成功時には
認証成功レスポンスを返り値として返します。
認証失敗時には例外が発生します。
@param user ユーザ名文字列
@param password パスワード文字列
@raise Net::IMAP::NoResponseError 認証に失敗した場合に発生します
@see Net::IMAP#... -
Net
:: IMAP # store(set , attr , flags) -> [Net :: IMAP :: FetchData] | nil (9373.0) -
STORE コマンドを送り、メールボックス内のメッセージを 更新します。
STORE コマンドを送り、メールボックス内のメッセージを
更新します。
set で更新するメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。
Net::IMAP#select で指定したメールボックスを対象とします。
attr で何をどのように変化させるかを指定します。
以下を指定することができます。
* "FLAGS"
* "+FLAGS"
* "-FLAGS"
それぞれメッセージのフラグの置き換え、追加、削除を意味します。
詳しくは 2060 の 6.4.6 を参考に... -
Net
:: IMAP # thread(algorithm , search _ keys , charset) -> [Net :: IMAP :: ThreadMember] (9373.0) -
THREADコマンドを送り、メールボックスを検索した結果を スレッド形式の木構造で返します。
THREADコマンドを送り、メールボックスを検索した結果を
スレッド形式の木構造で返します。
THREAD コマンドは 5256 で定義されています。
詳しくはそちらを参照してください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
algorithm は木構造を決定するためのアルゴリズムを指定します。
以下の2つが利用可能です。
* "ORDEREDSUBJECT" subjectを使って平坦に区切るだけ
* "REFERENCES" どのメッセージに返事をしているかを見て木構造を作る
詳しくは 5256 を見てく... -
Net
:: IMAP # uid _ store(set , attr , flags) -> [Net :: IMAP :: FetchData] | nil (9373.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] (9373.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... -
Psych
:: Nodes :: Mapping . new(anchor=nil , tag=nil , implicit=true , style=BLOCK) -> Psych :: Nodes :: Mapping (9373.0) -
新たな mapping オブジェクトを生成します。
新たな mapping オブジェクトを生成します。
anchor には mapping に付加されている anchor を文字列で指定します。
anchor を付けない場合には nil を指定します。
tag には mapping に付加されている tag を文字列で指定します。
tag を付けない場合には nil を指定します。
implicit には mapping が implicit に開始されたかどうかを
真偽値で指定します。
style には YAML ドキュメント上の style を整数で指定します。以下のいずれ
かを指定できます。
* Psych::Nodes::... -
Net
:: IMAP # copy(set , mailbox) -> Net :: IMAP :: TaggedResponse (9355.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 # fetch(set , attr) -> [Net :: IMAP :: FetchData] (9355.0) -
FETCH コマンドを送り、メールボックス内のメッセージに 関するデータを取得します。
FETCH コマンドを送り、メールボックス内のメッセージに
関するデータを取得します。
Net::IMAP#examine もしくは Net::IMAP#select で
指定したメールボックスを対象とします。
set で対象とするメッセージを指定します。
これには sequence number、sequence number の配列、もしくは
Range オブジェクトを渡します。
attr には取得するアトリビュートを文字列の配列で渡してください。
指定可能なアトリビュートについては Net::IMAP::FetchData#attr
を見てください。
例:
p imap.... -
Net
:: IMAP # move(set , mailbox) -> Net :: IMAP :: TaggedResponse (9355.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 # rename(mailbox , newname) -> Net :: IMAP :: TaggedResponse (9355.0) -
RENAME コマンドを送り、指定したメールボックスをリネームします。
RENAME コマンドを送り、指定したメールボックスをリネームします。
@param mailbox リネームするメールボックス(文字列)
@param newname リネーム後の名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
リネームできなかった場合に発生します。
指定した名前のメールボックスが存在しない場合や、
リネーム後の名前を持つメールボックスが既に存在する
場合に発生します。 -
Net
:: IMAP # setquota(mailbox , quota) -> Net :: IMAP :: TaggedResponse (9355.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 # starttls(certs , verify) -> Net :: IMAP :: TaggedResponse (9355.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 (9355.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 _ copy(set , mailbox) -> Net :: IMAP :: TaggedResponse (9355.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 _ fetch(set , attr) -> [Net :: IMAP :: FetchData] (9355.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 _ move(set , mailbox) -> Net :: IMAP :: TaggedResponse (9355.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 -
Set
# map! {|o| . . . } -> self (9340.0) -
集合の各要素についてブロックを評価し、その結果で元の集合を置き換えます。
集合の各要素についてブロックを評価し、その結果で元の集合を置き換えます。
//emlist[][ruby]{
require 'set'
set = Set['hello', 'world']
set.map! {|str| str.capitalize}
p set # => #<Set: {"Hello", "World"}>
//}
@see Enumerable#collect -
Net
:: IMAP # create(mailbox) -> Net :: IMAP :: TaggedResponse (9337.0) -
CREATE コマンドを送り、新しいメールボックスを作ります。
CREATE コマンドを送り、新しいメールボックスを作ります。
@param mailbox 新しいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスが作れなかった場合に発生します -
Net
:: IMAP # delete(mailbox) -> Net :: IMAP :: TaggedResponse (9337.0) -
DELETE コマンドを送り、指定したメールボックスを削除します。
DELETE コマンドを送り、指定したメールボックスを削除します。
@param mailbox 削除するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを削除できなかった場合
に発生します。指定した名前のメールボックスが存在しない場合や、
ユーザにメールボックスを削除する権限がない場合に発生します。 -
Net
:: IMAP # examine(mailbox) -> Net :: IMAP :: TaggedResponse (9337.0) -
EXAMINE コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。
EXAMINE コマンドを送り、指定したメールボックスを処理対象の
メールボックスにします。
Net::IMAP#select と異なりセッション中はメールボックスが
読み取り専用となります。それ以外は select と同じです。
@param mailbox 処理対象としたいメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError mailboxが存在しない等の理由でコマンドの実行に失敗
した場合に発生します。 -
Net
:: IMAP # getacl(mailbox) -> [Net :: IMAP :: MailboxACLItem] (9337.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] (9337.0) -
GETQUOTA コマンドを送って 指定したメールボックスの quota の情報を返します。
GETQUOTA コマンドを送って
指定したメールボックスの quota の情報を返します。
quota の情報は Net::IMAP::MailboxQuota オブジェクトの配列で
得られます。
詳しくは 2087 を見てください。
このコマンドは Net::IMAP#capability の返り値を見ることで
利用可能かどうか判断できます。
@param mailbox quota 情報を得たいメールボックス名
@raise Net::IMAP::NoResponseError 指定したメールボックスが quota root でない場合に発生します -
Net
:: IMAP # list(refname , mailbox) -> [Net :: IMAP :: MailboxList] | nil (9337.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 # lsub(refname , mailbox) -> [Net :: IMAP :: MailboxList] (9337.0) -
LIST コマンドを送り、active/subscribed なメールボックス名の集合から 引数にマッチするものすべてを返します。
LIST コマンドを送り、active/subscribed なメールボックス名の集合から
引数にマッチするものすべてを返します。
詳しくは 2060 の 6.3.8 を参照してください。
返り値は Net::IMAP::MailboxList の配列で返します。
返り値が空集合である場合は空の配列でなく nil を返します。
@param refname 参照名(文字列)
@param mailbox 調べるメールボックスの名前(文字列)。ワイルドカードを含んでいてもかまいません。 -
Net
:: IMAP # select(mailbox) -> Net :: IMAP :: TaggedResponse (9337.0) -
SELECT コマンドを送り、指定したメールボックスを処理対象の メールボックスにします。
SELECT コマンドを送り、指定したメールボックスを処理対象の
メールボックスにします。
このコマンドが成功すると、クライアントの状態が「selected」になります。
このコマンドを実行した直後に Net::IMAP#responses["EXISTS"].last
を調べると、メールボックス内のメールの数がわかります。
また、Net::IMAP#responses["RECENT"].lastで、
最新のメールの数がわかります。
これらの値はセッション中に変わりうることに注意してください。
Net::IMAP#add_response_handler を使うとそのような更新情報を
即... -
Net
:: IMAP # subscribe(mailbox) -> Net :: IMAP :: TaggedResponse (9337.0) -
SUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合に 追加します。
SUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合に
追加します。
@param mailbox 追加するメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
追加できなかった場合に発生します。
指定した名前のメールボックスが存在しない場合などに
生じます。 -
Net
:: IMAP # unsubscribe(mailbox) -> Net :: IMAP :: TaggedResponse (9337.0) -
UNSUBSCRIBE コマンドを送り、指定したメールボックスを "active" もしくは "subscribe" なメールボックスの集合から 削除します。
UNSUBSCRIBE コマンドを送り、指定したメールボックスを
"active" もしくは "subscribe" なメールボックスの集合から
削除します。
@param mailbox 削除するするメールボックスの名前(文字列)
@raise Net::IMAP::NoResponseError 指定した名前のメールボックスを
削除できなかった場合に発生します。
指定した名前のメールボックスが active/subscribe でなかった
場合などに発生します。 -
Net
:: IMAP # xlist(refname , mailbox) -> [Net :: IMAP :: MailboxList] (9337.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 :: BodyTypeBasic # disposition -> Net :: IMAP :: ContentDisposition | nil (9319.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMessage # disposition -> Net :: IMAP :: ContentDisposition | nil (9319.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeMultipart # disposition -> Net :: IMAP :: ContentDisposition | nil (9319.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: BodyTypeText # disposition -> Net :: IMAP :: ContentDisposition | nil (9319.0) -
Content-Dispotition の値を返します。
Content-Dispotition の値を返します。
Net::IMAP::ContentDisposition オブジェクトを返します。
@see 1806, 2183 -
Net
:: IMAP :: ResponseText # code -> Net :: IMAP :: ResponseCode | nil (9319.0) -
レスポンスコードを返します。
レスポンスコードを返します。
応答がレスポンスコードを含んでいない場合は nil を返します。
@see Net::IMAP::ResponseCode -
Net
:: IMAP :: TaggedResponse # data -> Net :: IMAP :: ResponseText (9319.0) -
レスポンスを解析したオブジェクトを返します。
レスポンスを解析したオブジェクトを返します。
@see Net::IMAP::ResponseText -
Exception2MessageMapper
. def _ exception(klass , exception _ name , message _ format , superklass = StandardError) -> Class (9091.0) -
exception_name という名前の例外クラスを定義します。
exception_name という名前の例外クラスを定義します。
@param klass 一階層上となるクラス名を指定します。
@param exception_name 例外クラスの名前をシンボルで指定します。
@param message_format メッセージのフォーマットを指定します。
Kernel.#sprintf のフォーマット文字列と同じ形式を使用できます。
@param superklass 定義する例外クラスのスーパークラスを指定します。
省略すると StandardError を使用... -
ObjectSpace
:: WeakMap # []=(key , value) (9091.0) -
引数 key から引数 value への参照を作成します。
引数 key から引数 value への参照を作成します。
@param key 参照元のオブジェクトを指定します。
@param value 参照先のオブジェクトを指定します。
//emlist[例][ruby]{
weak_map = ObjectSpace::WeakMap.new
key = "text"
weak_map[key] = "test" # => test
weak_map[key] # => test
//} -
Exception2MessageMapper
. e2mm _ message(klass , exp) -> String | nil (9085.0) -
@todo
@todo
@param klass
@param exp -
Exception2MessageMapper
. message(klass , exp) -> String | nil (9085.0) -
@todo
@todo
@param klass
@param exp -
Exception2MessageMapper
. Fail(klass = E2MM , exception _ class = nil , *rest) -> () (9073.0) -
登録されている情報を使用して、例外を発生させます。
登録されている情報を使用して、例外を発生させます。
@param klass 一階層上となるクラス名を指定します。
@param exception_class 例外クラス。
@param rest メッセージに埋め込む値。
@raise Exception2MessageMapper::ErrNotRegisteredException 指定された例外クラスに対応するメッセージが存在しない場合に発生します。 -
Exception2MessageMapper
. Raise(klass = E2MM , exception _ class = nil , *rest) -> () (9073.0) -
登録されている情報を使用して、例外を発生させます。
登録されている情報を使用して、例外を発生させます。
@param klass 一階層上となるクラス名を指定します。
@param exception_class 例外クラス。
@param rest メッセージに埋め込む値。
@raise Exception2MessageMapper::ErrNotRegisteredException 指定された例外クラスに対応するメッセージが存在しない場合に発生します。 -
Exception2MessageMapper
. def _ e2message(klass , exception _ class , message _ format) -> Class (9073.0) -
すでに存在する例外クラス exception_class に、 エラーメッセージ用フォーマット message_format を関連づけます。
すでに存在する例外クラス exception_class に、
エラーメッセージ用フォーマット message_format を関連づけます。
@param klass 一階層上となるクラス名を指定します。
@param exception_class メッセージを登録する例外クラスを指定します。
@param message_format メッセージのフォーマットを指定します。
Kernel.#sprintf のフォーマット文字列と同じ形式を使用できます。
@return exception_class を返します。 -
Net
:: IMAP # search(keys , charset = nil) -> [Integer] (9073.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 # uid _ search(keys , charset = nil) -> [Integer] (9073.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([... -
Exception2MessageMapper
# bind(cl) -> () (9067.0) -
@todo
@todo
@param cl xxx -
Exception2MessageMapper
. extend _ object(cl) -> () (9067.0) -
@todo
@todo
@param cl -
Exception2MessageMapper
# Fail(exception _ class = nil , *rest) -> () (9055.0) -
登録されている情報を使用して、例外を発生させます。
登録されている情報を使用して、例外を発生させます。
@param exception_class 例外クラス。
@param rest メッセージに埋め込む値。
@raise Exception2MessageMapper::ErrNotRegisteredException 指定された例外クラスに対応するメッセージが存在しない場合に発生します。
例:
class Foo
extend Exception2MessageMapper
p def_exception :NewExceptionClass, "message...%d, %d and %d" # =>... -
Exception2MessageMapper
# Raise(exception _ class = nil , *rest) -> () (9055.0) -
登録されている情報を使用して、例外を発生させます。
登録されている情報を使用して、例外を発生させます。
@param exception_class 例外クラス。
@param rest メッセージに埋め込む値。
@raise Exception2MessageMapper::ErrNotRegisteredException 指定された例外クラスに対応するメッセージが存在しない場合に発生します。
例:
class Foo
extend Exception2MessageMapper
p def_exception :NewExceptionClass, "message...%d, %d and %d" # =>... -
Exception2MessageMapper
# def _ e2message(exception _ class , message _ format) -> Class (9055.0) -
すでに存在する例外クラス exception_class に、 エラーメッセージ用フォーマット message_format を関連づけます。
すでに存在する例外クラス exception_class に、
エラーメッセージ用フォーマット message_format を関連づけます。
このフォーマットは Exception2MessageMapper#Raise,
Exception2MessageMapper#Fail で使用します。
@param exception_class メッセージを登録する例外クラスを指定します。
@param message_format メッセージのフォーマットを指定します。
Kernel.#sprintf のフォーマット文字列と同じ形式を使用できます... -
Exception2MessageMapper
# def _ exception(exception _ name , message _ format , superclass = StandardError) -> Class (9055.0) -
exception_name という名前の例外クラスを定義します。
exception_name という名前の例外クラスを定義します。
@param exception_name 定義する例外クラスの名前をシンボルで指定します。
@param message_format メッセージのフォーマット。
@param superclass 定義する例外のスーパークラスを指定します。
省略すると StandardError を使用します。 -
Exception2MessageMapper
# fail(exception _ class = nil , *rest) -> () (9055.0) -
登録されている情報を使用して、例外を発生させます。
登録されている情報を使用して、例外を発生させます。
@param exception_class 例外クラス。
@param rest メッセージに埋め込む値。
@raise Exception2MessageMapper::ErrNotRegisteredException 指定された例外クラスに対応するメッセージが存在しない場合に発生します。 -
Net
:: IMAP # setacl(mailbox , user , rights) (9055.0) -
SETACL コマンドを送り、指定したメールボックスに 指定したユーザに関する権限を設定します。
SETACL コマンドを送り、指定したメールボックスに
指定したユーザに関する権限を設定します。
rights には設定する権限を表す文字列を指定します。
どのような文字列を指定すべきかは 2086 を参照してください。
rights に nil を渡すと、空文字列を指定したのと同様、つまり
すべての権限を削除します。
@param mailbox 権限を設定するメールボックスの名前(文字列)
@param user 権限を設定するユーザの名前(文字列)
@param rights 権限を表す文字列 -
Net
:: IMAP # sort(sort _ keys , search _ keys , charset) -> [Integer] (9055.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} (9055.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 # uid _ sort(sort _ keys , search _ keys , charset) -> [Integer] (9055.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 _ response _ handler(handler) -> () (9037.0) -
レスポンスハンドラを追加します。
レスポンスハンドラを追加します。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。
レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_respo... -
Net
:: IMAP # add _ response _ handler(handler) {|resp| . . . } -> () (9037.0) -
レスポンスハンドラを追加します。
レスポンスハンドラを追加します。
レスポンスハンドラはサーバから応答を受け取るごとに
呼びだされます。ハンドラには
Net::IMAP::TaggedResponse もしくは
Net::IMAP::UntaggedResponse オブジェクトが
渡されます。
主にサーバからの非同期的なイベントを受け取るため
に用います。例えば EXISTS 応答を受け取る
(メールボックスに新たなメールが追加されたタイミングで発生します)
ためなどに用いられます。
レスポンスハンドラはメインのスレッドとは別のスレッドで
呼びだされることに注意してください。
例:
imap.add_respo... -
Net
:: IMAP # remove _ response _ handler(handler) -> () (9037.0) -
レスポンスハンドラを削除します。
レスポンスハンドラを削除します。
@param handler 削除するハンドラ
@see Net::IMAP#add_response_handler -
Net
:: IMAP . add _ authenticator(auth _ type , authenticator) -> () (9037.0) -
Net::IMAP#authenticate で使う 認証用クラスを設定します。
Net::IMAP#authenticate で使う
認証用クラスを設定します。
imap ライブラリに新たな認証方式を追加するために用います。
通常は使う必要はないでしょう。もしこれを用いて
認証方式を追加する場合は net/imap.rb の
Net::IMAP::LoginAuthenticator などを参考にしてください。
@param auth_type 認証の種類(文字列)
@param authenticator 認証クラス(Class オブジェクト) -
Net
:: IMAP . debug=(val) (9037.0) -
デバッグモードの on/off をします。
デバッグモードの on/off をします。
真を渡すと on になります。
@param val 設定するデバッグモードの on/off の真偽値
@see Net::IMAP#debug -
Net
:: IMAP . decode _ utf7(str) -> String (9037.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 (9037.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 . max _ flag _ count=(count) (9037.0) -
サーバからのレスポンスに含まれる flag の上限を設定します。
サーバからのレスポンスに含まれる flag の上限を設定します。
これを越えた flag がレスポンスに含まれている場合は、
Net::IMAP::FlagCountError 例外が発生します。
デフォルトは 10000 です。通常は変える必要はないでしょう。
@param count 設定する最大値の整数
@see Net::IMAP.max_flag_count -
Psych
:: Nodes :: Mapping # anchor=(a) (9037.0) -
mapping に付加する anchor を設定します。
mapping に付加する anchor を設定します。
@param a 設定する anchor
@see Psych::Nodes::Mapping#anchor,
Psych::Nodes::Mapping.new -
Psych
:: Nodes :: Mapping # implicit=(bool) (9037.0) -
mapping が implicit に開始されたかどうかを真偽値で設定します。
mapping が implicit に開始されたかどうかを真偽値で設定します。
@param bool 設定値
@see Psych::Nodes::Mapping#implicit,
Psych::Nodes::Mapping.new -
Psych
:: Nodes :: Mapping # style=(sty) (9037.0) -
mapping の style を設定します。
mapping の style を設定します。
@param sty 設定する style
@see Psych::Nodes::Mapping#style,
Psych::Nodes::Mapping.new -
Psych
:: Nodes :: Mapping # tag=(t) (9037.0) -
mapping に付加する tag を設定します。
mapping に付加する tag を設定します。
@param t 設定する tag
@see Psych::Nodes::Mapping#anchor=,
Psych::Nodes::Mapping.new -
Net
:: IMAP # disconnect -> nil (9019.0) -
サーバとの接続を切断します。
サーバとの接続を切断します。
@see Net::IMAP#disconnected? -
Net
:: IMAP # disconnected? -> bool (9019.0) -
サーバとの接続が切断されていれば真を返します。
サーバとの接続が切断されていれば真を返します。
@see Net::IMAP#disconnect