JavaScript Editor Javascript debugger     Website design 


Read the list of mailboxes (PHP 4, PHP 5)
array imap_list ( resource imap_stream, string ref, string pattern )

Read the list of mailboxes.



An IMAP stream returned by imap_open().


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


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.


Example 1053. imap_list() example

= imap_open("{}", "username", "password", OP_HALFOPEN)
     or die(
"can't connect: " . imap_last_error());

$list = imap_list($mbox, "{}", "*");
if (
is_array($list)) {
   foreach (
$list as $val) {
imap_utf7_decode($val) . "\n";
} else {
"imap_list failed: " . imap_last_error() . "\n";