(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
, вернёт почтовые ящики
только на самом верхнем уровне; '~/mail/%
'
на UW_IMAPD
вернёт все ящики в директории ~/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);
?>