imap_listscan
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_listscan — Отримує список поштових скриньок, імена яких містять заданий рядок
Опис
imap_listscan( IMAP\Connection $imap, string $reference, string $pattern, string $content): array|false
Повертає масив, що містить імена поштових скриньок, що містять content
в тексте.
Ця функція схожа на imap_listmailbox(), але також виявляє присутність рядка content
всередині даних поштової скриньки.
Список параметрів
imap
Екземпляр IMAP\Connection
reference
Вreference
, як правило, повинна бути вказана лише специфікація сервера, як описано в imap_open()
Увага
Якщо imap.enable_insecure_rsh не вимкнено, то передача в цей параметр не перевірених даних не безпечна
pattern
Визначає початок пошуку в ієрархії поштових скриньок.
Є два спеціальні символи, які можна використовувати при передачі як частину pattern
: '*
'і'%
'. '*
' повертає всі поштові скриньки. Якщо ви передасте pattern
як '*
', то отримайте повний список ієрархії поштових скриньок. '%
' поверне лише поточний рівень. '%
', переданий як параметр pattern
, поверне поштові скриньки лише на верхньому рівні; '~/mail/%
' на UW_IMAPD
поверне всі ящики в директорії ~/mail, крім тих, що знаходяться в її піддиректорії.
content
Шуканий рядок
Значення, що повертаються
Повертає масив, що містить імена поштових скриньок, що містять content
в тексте или**false
**в случае возникновения ошибки.
список змін
Версия | Опис |
---|---|
8.1.0 | Параметрimap тепер чекає екземпляр IMAP\Connection; раніше очікувався ресурс (resourceimap |
Дивіться також
- imap_listmailbox() - Псевдонім imap_list
- imap_search() - Отримує повідомлення, які відповідають заданим критеріям