imap_list

(PHP 3 >= 3.0.4, PHP 4, PHP 5)

imap_list -- Liste der Postfächer lesen

Beschreibung

array imap_list ( resource imap_stream, string ref, string pattern )

imap_list() liest die Liste aller Pöstfächer.

Parameter Liste

imap_stream

An IMAP stream returned by imap_open().

ref

Angabe des Servers wie in imap_open() beschrieben.

pattern

Gibt an ab wo in der Postfach-Hierachie gesucht werden soll.

Die Zeichen '*' und '%' haben innerhalb des Suchmusters pattern besondere Bedeutung. '*' liefert die gesamte Postfach-Hierachie, '%' dagege nur die Postfächer auf der aktuellen Hierachiestufe. Ein '*' alleine liefert also eine Liste aller Postfächer, ein '%' dagegen nur die Postfächer der obersten Ebene. '~/mail/%' bei einem UW_IMAPD Server liefert alle Postfächer im ~/mail Verzeichnis aber nicht deren Unterordner. directory.

Rückgabewerte

Liefert ein Array mit den Namen der gefundenen Postfächer.

Beispiele

Beispiel 1. imap_list() Beispiel

<?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);
?>

Siehe auch

imap_getmailboxes()
imap_lsub()