IMAP_LIST(3) 1 IMAP_LIST(3)
imap_list - Read the list of mailboxes
SYNOPSIS
array imap_list (resource $imap_stream, string $ref, string $pattern)
DESCRIPTION
Read the list of mailboxes.
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 containing the names of the mailboxes.
EXAMPLES
Example #1
imap_list(3) example
<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("can't connect: " . imap_last_error());
$list = imap_list($mbox, "{imap.example.org}", "*");
if (is_array($list)) {
foreach ($list as $val) {
echo imap_utf7_decode($val) . "
";
}
} else {
echo "imap_list failed: " . imap_last_error() . "
";
}
imap_close($mbox);
?>
SEE ALSO
imap_getmailboxes(3), imap_lsub(3).
PHP Documentation Group IMAP_LIST(3)
