imap_list

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

imap_list — Читає список поштових скриньок

Опис

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

Читає список поштових скриньок.

Список параметрів

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()****

Loading...

Дивіться також

imap_getmailboxes() - Читає список поштових скриньок, повертаючи докладну інформацію щодо кожного з них
imap_lsub() - Отримує список усіх поштових скриньок, на які оформлена передплата