imap_list - Read the list of mailboxes
Вернуться к: IMAP Функции
imap_list
(PHP 4, PHP 5, PHP 7)
imap_list — Read the list of mailboxes
Описание
$imap_stream
, string $ref
, string $pattern
)Read the list of mailboxes.
Список параметров
-
imap_stream -
Поток IMAP, полученный из imap_open().
-
ref -
refshould normally be just the server specification as described in imap_open(). -
pattern -
Определяет начало поиска в иерархии почтовых ящиков.
Есть два специальных символа, которые можно использовать при передаче как часть
pattern: '*' и '%'. '*' возвращает все почтовые ящики. Если вы передадитеpatternкак '*', то получите полный список иерархии почтовых ящиков. '%' вернет только текущий уровень. '%', переданный как параметрpattern, вернет почтовые ящики только на самом верхнем уровне; '~/mail/%' на UW_IMAPD вернет все ящики в директории ~/mail, кроме тех, которые находятся в ее поддиректориях.
Возвращаемые значения
Returns an array containing the names of the mailboxes.
Примеры
Пример #1 imap_list() example
<?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_getmailboxes() - Read the list of mailboxes, returning detailed information on each one
- imap_lsub() - List all the subscribed mailboxes
Вернуться к: IMAP Функции