php man page for imap_lsub

IMAP_LSUB(3)								 1							      IMAP_LSUB(3)

imap_lsub - List all the subscribed mailboxes

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

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

PARAMETERS
	      o $
		imap_stream -An IMAP stream returned by imap_open(3).

	      o $ref
		-$ref should normally be just the server specification as described in imap_open(3)

	      o $pattern
		-Specifies  where  in  the mailbox hierarchy to start searching.There are two special characters you can pass as part of the $pat-
		tern: ' *' 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
       imap_list(3), imap_getmailboxes(3).

PHP Documentation Group 													      IMAP_LSUB(3)