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

instance method Net::IMAP#xlist

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

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

Net::IMAP#list とほぼ同様ですが、 「:Sent」などの拡張されたフラグを含むことが異なります。

詳しくは http://code.google.com/apis/gmail/imap/ を参照してください。

[PARAM] refname:

参照名(文字列)

[PARAM] mailbox:

調べるメールボックスの名前(文字列)。ワイルドカードを含んでいてもかまいません。

例:

imap.create("foo/bar")
imap.create("foo/baz")
p imap.xlist("", "foo/%")
#=> [#<Net::IMAP::MailboxList attr=[:Noselect], delim="/", name="foo/">, \\
#    #<Net::IMAP::MailboxList attr=[:Noinferiors, :Marked], delim="/", name="foo/bar">, \\
#    #<Net::IMAP::MailboxList attr=[:Noinferiors], delim="/", name="foo/baz">]