(PHP 4, PHP 5)
imap_list — Liste der Postfächer lesen
imap_list() liest die Liste aller Pöstfächer.
Eine von imap_open() zurückgegebene IMAP-Verbindung.
Angabe des Servers wie in imap_open() beschrieben.
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.
Liefert ein Array mit den Namen der gefundenen Postfächer.
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);
?>
imap_list returns a simple array of strings that look just like the $ref parameter one needs to specify:
<?php
$srv = '{imap.example.com}';
$conn = imap_open($srv, 'me', 'mypass');
$boxes = imap_list($conn, $srv, '*');
print_r($boxes);
imap_close($conn);
?>
Output:
<pre>
Array
(
[0] => {imap.example.com}Calendar
[1] => {imap.example.com}Contacts
[2] => {imap.example.com}Deleted Items
[3] => {imap.example.com}Drafts
[4] => {imap.example.com}Journal
[5] => {imap.example.com}Junk E-mail
[6] => {imap.example.com}Notes
[7] => {imap.example.com}Outbox
[8] => {imap.example.com}RSS Feeds
[9] => {imap.example.com}Sent Items
[10] => {imap.example.com}Tasks
)
</pre>
These directly fill in the $ref argument for every function that takes one.
if there is an error imap_list returns FALSE not an empty array (as expected by docs)