(PHP 4, PHP 5, PHP 7, PHP 8)
imap_list — Читает список почтовых ящиков
Читает список почтовых ящиков.
imapЭкземпляр класса IMAP\Connection.
reference
В reference, как правило, должна быть
указана только спецификация сервера, как описано в
imap_open().
Передача в этот параметр непроверенных данных небезопасна, если включили директиву imap.enable_insecure_rsh.
patternОпределяет начало поиска в иерархии почтовых ящиков.
Как часть параметра pattern
перадают два специальных символа: '*' и '%'.
Символ '*' означает возврат всех почтовых ящиков. Если передать
параметр pattern как '*', возвращается полный список иерархии почтовых ящиков.
Символ '%' означает возврат только текущего уровня.
Символ '%' как значение параметра pattern вернёт почтовые ящики
только верхнего уровня; с серверов UW_IMAPD значение '~/mail/%'
вернёт почтовые ящики каталога ~/mail,
но не подкаталогов этого каталога.
Возвращает массив с именами почтовых ящиков или false в случае неудачи.
| Версия | Описание |
|---|---|
| 8.1.0 |
Параметр imap теперь ожидает экземпляр класса IMAP\Connection;
раньше параметр ждал ресурс (resource) imap.
|
Пример #1 Пример использования imap_list()
<?php
$mbox = imap_open("{imap.example.org}", "username", "password", OP_HALFOPEN)
or die("не удалось подключиться: " . 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 завершился с ошибкой: " . imap_last_error() . "\n";
}
imap_close($mbox);
?>