File: C:/Ruby27-x64/lib/ruby/gems/2.7.0/doc/net-imap-0.3.4/ri/Net/IMAP/xlist-i.ri
U:RDoc::AnyMethod[iI"
xlist:ETI"Net::IMAP#xlist;TF:publico:RDoc::Markup::Document:@parts[o:RDoc::Markup::Paragraph; [I"?Sends a XLIST command, and returns a subset of names from ;TI"<the complete set of all names available to the client. ;TI"B+refname+ provides a context (for instance, a base directory ;TI"Cin a directory-based mailbox hierarchy). +mailbox+ specifies ;TI"@a mailbox or (via wildcards) mailboxes under that context. ;TI"@Two wildcards may be used in +mailbox+: '*', which matches ;TI"Gall characters *including* the hierarchy delimiter (for instance, ;TI"G'/' on a UNIX-hosted directory-based mailbox hierarchy); and '%', ;TI"Cwhich matches all characters *except* the hierarchy delimiter.;To:RDoc::Markup::BlankLine o;
; [I"DIf +refname+ is empty, +mailbox+ is used directly to determine ;TI"@which mailboxes to match. If +mailbox+ is empty, the root ;TI"@name of +refname+ and the hierarchy delimiter are returned.;T@o;
; [I"FThe XLIST command is like the LIST command except that the flags ;TI"Ereturned refer to the function of the folder/mailbox, e.g. :Sent;T@o;
; [I"FThe return value is an array of MailboxList objects. For example:;T@o:RDoc::Markup::Verbatim; [I"imap.create("foo/bar")
;TI"imap.create("foo/baz")
;TI"p imap.xlist("", "foo/%")
;TI"Q#=> [#<Net::IMAP::MailboxList attr=[:Noselect], delim="/", name="foo/">, \\
;TI"` #<Net::IMAP::MailboxList attr=[:Noinferiors, :Marked], delim="/", name="foo/bar">, \\
;TI"T #<Net::IMAP::MailboxList attr=[:Noinferiors], delim="/", name="foo/baz">]
;T:@format0o;
; [I" Related: #list, MailboxList;T@S:RDoc::Markup::Heading:
leveli
: textI"Capabilities;T@o;
; [I"5The server's capabilities must include +XLIST+, ;TI">a deprecated Gmail extension (replaced by +SPECIAL-USE+).;T:
@fileI"lib/net/imap.rb;T:0@omit_headings_from_table_of_contents_below000[ I"(refname, mailbox);T@4FI" IMAP;TcRDoc::NormalClass00