(PHP 4, PHP 5, PHP 7)
imap_list — Прочитать список почтовых ящиков
$imap_stream
, string $ref
, string $pattern
) : arrayЧитает список почтовых ящиков.
imap_streamПоток IMAP, полученный из imap_open().
ref
В ref, как правило, должна быть
указана только спецификация сервера, как описано в
imap_open().
Если imap.enable_insecure_rsh не отключен, то передача в этот параметр не проверенных данных не безопасна.
patternОпределяет начало поиска в иерархии почтовых ящиков.
Есть два специальных символа, которые можно использовать при передаче
как часть pattern:
'*' и '%'.
'*' возвращает все почтовые ящики. Если вы передадите
pattern как '*', то получите полный список иерархии почтовых ящиков.
'%' вернет только текущий уровень.
'%', переданный как параметр pattern, вернет почтовые ящики
только на самом верхнем уровне; '~/mail/%'
на UW_IMAPD вернет все ящики в директории ~/mail, кроме тех, которые
находятся в ее поддиректориях.
Возвращает массив с именами почтовых ящиков или FALSE в случае неудачи.
Пример #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);
?>