PHP 4, PHP 5, PHP 7, PHP 8
imap_list - Read the list of mailboxes
Code Examples

imap_list( IMAP\Connection$imap, string$reference, string$pattern ): array|false

Read the list of mailboxes.



An IMAP\Connection instance.


reference 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 containing the names of the mailboxes or false in case of failure.


Version Description
8.1.0 The imap parameter expects an IMAP\Connection instance now; previously, a resource was expected.

Related Functions

Example of imap_list

Show all examples for imap_list

PHP Version:

Function imap_list:

IMAP, POP3 and NNTP Functions

Most used PHP functions