Home/ Manual/ imap / functions/ imap_list

imap_list

PHP function Edit on GitHub ✎

(PHP 4, PHP 5, PHP 7, PHP 8)

Read the list of mailboxes

Description

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

Read the list of mailboxes.

Parameters

reference

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

Insecure

pattern

Pattern

Return Values

Returns an array containing the names of the mailboxes or false in case of failure.

Changelog

Version	Description

Examples

imap_list() example

php

<?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) . "\n";
    }
} else {
    echo "imap_list failed: " . imap_last_error() . "\n";
}

imap_close($mbox);
?>