array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'uk', ), 'this' => array ( 0 => 'function.imap-getmailboxes.php', 1 => 'imap_getmailboxes', 2 => 'Read the list of mailboxes, returning detailed information on each one', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'IMAP Функції', ), 'prev' => array ( 0 => 'function.imap-getacl.php', 1 => 'imap_getacl', ), 'next' => array ( 0 => 'function.imap-getsubscribed.php', 1 => 'imap_getsubscribed', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/imap/functions/imap-getmailboxes.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

imap_getmailboxes

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

imap_getmailboxes — Read the list of mailboxes, returning detailed information on each one

Опис

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

Gets information on the mailboxes.

Параметри

imap

Примірник IMAP\Connection.

reference

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

Увага

Передавати у цей параметр неперевірені дані небезпечно, якщо увімкнено imap.enable_insecure_rsh.

pattern

Визначає, де в ієрархії поштових скриньок почати пошук.

У значенні параметру pattern можна використовувати два спеціальні символи: "*" і "%". "*" — повернути всі поштові скриньки. Якщо значення pattern дорівнюватиме "*", то повернеться список усієї ієрархії поштових скриньок. "%" — повернути тільки поточний рівень. Якщо значення pattern дорівнюватиме "%", то повернеться тільки верхній рівень поштових скриньок; "~/mail/%" на UW_IMAPD поверне усі поштові скриньки в теці ~/mail, крім тих, що в її підтеках.

Значення, що повертаються

Returns an array of objects containing mailbox information. Each object has the attributes name, specifying the full name of the mailbox; delimiter, which is the hierarchy delimiter for the part of the hierarchy this mailbox is in; and attributes. Attributes is a bitmask that can be tested against:

The function returns false on failure.

Журнал змін

Версія Опис
8.1.0 Тепер параметр imap має бути примірником IMAP\Connection; раніше очікувався дійсний resource imap.

Приклади

Приклад #1 imap_getmailboxes() example

<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("can't connect: " . imap_last_error());

$list = imap_getmailboxes($mbox, "{imap.example.org}", "*");
if (is_array($list)) {
foreach ($list as $key => $val) {
echo "($key) ";
echo imap_utf7_decode($val->name) . ",";
echo "'" . $val->delimiter . "',";
echo $val->attributes . "<br />\n";
}
} else {
echo "imap_getmailboxes failed: " . imap_last_error() . "\n";
}

imap_close($mbox);
?>

Прогляньте також