| Current Path : /usr/local/share/ri/1.8/system/Net/IMAP/ |
FreeBSD hs32.drive.ne.jp 9.1-RELEASE FreeBSD 9.1-RELEASE #1: Wed Jan 14 12:18:08 JST 2015 root@hs32.drive.ne.jp:/sys/amd64/compile/hs32 amd64 |
| Current File : //usr/local/share/ri/1.8/system/Net/IMAP/list-i.yaml |
--- !ruby/object:RI::MethodDescription aliases: [] block_params: comment: - !ruby/struct:SM::Flow::P body: "Sends a LIST command, and returns a subset of names from the complete set of all names available to the client. <tt>refname</tt> provides a context (for instance, a base directory in a directory-based mailbox hierarchy). <tt>mailbox</tt> specifies a mailbox or (via wildcards) mailboxes under that context. Two wildcards may be used in <tt>mailbox</tt>: '*', which matches all characters <b>including</b> the hierarchy delimiter (for instance, '/' on a UNIX-hosted directory-based mailbox hierarchy); and '%', which matches all characters <b>except</b> the hierarchy delimiter." - !ruby/struct:SM::Flow::P body: If <tt>refname</tt> is empty, <tt>mailbox</tt> is used directly to determine which mailboxes to match. If <tt>mailbox</tt> is empty, the root name of <tt>refname</tt> and the hierarchy delimiter are returned. - !ruby/struct:SM::Flow::P body: "The return value is an array of +Net::IMAP::MailboxList+. For example:" - !ruby/struct:SM::Flow::VERB body: " imap.create("foo/bar")\n imap.create("foo/baz")\n p imap.list("", "foo/%")\n #=> [#<Net::IMAP::MailboxList attr=[:Noselect], delim="/", name="foo/">, \\\n #<Net::IMAP::MailboxList attr=[:Noinferiors, :Marked], delim="/", name="foo/bar">, \\\n #<Net::IMAP::MailboxList attr=[:Noinferiors], delim="/", name="foo/baz">]\n" full_name: Net::IMAP#list is_singleton: false name: list params: (refname, mailbox) visibility: public