array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'de', ), 'this' => array ( 0 => 'function.imap-list.php', 1 => 'imap_list', 2 => 'Liefert die Liste der Postfächer', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'IMAP Funktionen', ), 'prev' => array ( 0 => 'function.imap-last-error.php', 1 => 'imap_last_error', ), 'next' => array ( 0 => 'function.imap-listmailbox.php', 1 => 'imap_listmailbox', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'de', 'path' => 'reference/imap/functions/imap-list.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

imap_list

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

imap_list — Liefert die Liste der Postfächer

Beschreibung

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

Gibt die Liste aller Pöstfächer zurück.

Parameter-Liste

imap

Eine IMAP\Connection-Instanz.

reference

Die Angabe des Servers in der in imap_open() beschriebenen Form.

Warnung

Die Übergabe von nicht vertrauenswürdigen Daten an diesen Parameter ist unsicher,falls imap.enable_insecure_rsh nicht deaktiviert ist.

pattern

Gibt an, wo in der Postfach-Hierarchie mit der Suche begonnen werden soll.

Es gibt zwei Sonderzeichen, die man als Teil von pattern verwenden kann: '*' und '%'. '*' heißt, dass alle Postfächer zurückgegeben werden sollen. Wenn man pattern als '*' übergibt, so erhält man eine Liste der vollständigen Postfach-Hierarchie. '%' heißt, dass nur die aktuelle Stufe zurückgegeben wird. '%' als Wert des Parameters pattern gibt nur die Postfächer der obersten Ebene zurück. '~/mail/%' unter UW_IMAPD gibt alle Postfächer des Verzeichnisses ~/mail zurück, aber keine aus dessen Unterverzeichnissen.

Rückgabewerte

Gibt ein Array mit den Namen der gefundenen Postfächer zurück oder false im Fehlerfall.

Changelog

Version Beschreibung
8.1.0 Der Parameter imap erwartet nun eine IMAP\Connection-Instanz; vorher wurde eine gültige imap-Ressource erwartet.

Beispiele

Beispiel #1 imap_list()-Beispiel

<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("Kann keine Verbindung aufbauen: " . 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 schlug fehl: " . imap_last_error() . "\n";
}

imap_close($mbox);
?>

Siehe auch