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

instance method Net::IMAP#list

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

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

詳しくは [RFC2060] の 6.3.8 を参照してください。

返り値は Net::IMAP::MailboxList の配列で返します。 返り値が空集合である場合は空の配列でなく nil を返します。

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

例:

imap.create("foo/bar")
imap.create("foo/baz")
p imap.list("", "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">]