imap_getmailboxes -- Read the list of mailboxes, returning detailed information on each one


array imap_getmailboxes(int imap_stream, string ref, string pat);

Returns an array of objects containing mailbox information. Each object has the attributes name, specifying the full name of the mailbox; delimiter, which is the hierarchy delimiter for the part of the hierarchy this mailbox is in; and attributes. Attributes is a bitmask that can be tested against:

ref should normally be just the IMAP server, in the form: {imap_server:imap_port}, and pattern specifies where in the mailbox hierarchy to start searching. If you want all mailboxes, pass pattern as an empty string.

There are two special characters you can pass as part of the pattern: '*' and '%'. '*' means to return all mailboxes. If you pass pattern as '*', you will get a list of the entire mailbox hierarchy. '%' means to return the current level only. '%' as the pattern parameter will return only the top level mailboxes; '~/mail/%' on UW_IMAPD will return every mailbox in the ~/mail directory, but none in subfolders of that directory.