Please wait while we load your page...


PHP Manual [imap_lsub]

Protect Your Website Today

PHP Manual || IMAP Functions

(PHP 4, PHP 5, PHP 7)

imap_lsubList all the subscribed mailboxes


imap_lsub ( resource $imap_stream , string $ref , string $pattern ) : array

Gets an array of all the mailboxes that you have subscribed.



An IMAP stream returned by imap_open().


ref should normally be just the server specification as described in imap_open()


Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.


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 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.

Return Values

Returns an array of all the subscribed mailboxes.

See Also

PHP Manual || IMAP Functions