imap_lsub

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

imap_lsub — Отримує список усіх поштових скриньок, на які оформлена передплата

Опис

imap_lsub(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; раніше очікувався ресурс (resourceimap

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

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