array imap_lsub(resource $imap_stream, string $ref, string $pattern)
Gets an array of all the mailboxes that you have subscribed.
Returns an array of all the subscribed mailboxes.
- resource $imap_stream: An IMAP stream returned by imap_open().
- string $ref:
refshould normally be just the server specification as described in imap_open()
- string $pattern: Specifies where in the mailbox hierarchy to start searching.
There are two special characters you can pass as part of the
pattern: '*' and '%'. '*' means to return all mailboxes. If you pass
patternas '*', you will get a list of the entire mailbox hierarchy. '%' means to return the current level only. '%' as the
patternparameter 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.