imap_listscan — Получает список почтовых ящиков, имена которых содержат заданную строку

Назначение imap_listscan

imap_listscan: Получает список почтовых ящиков, имена которых содержат заданную строку. Справочная сущность относится к разделу «imap». Используйте её, когда это краткое назначение совпадает с задачей приложения; фактическое поведение подтверждайте сигнатурой и проверочным сценарием ниже.

Чем отличается imap_listscan

Это процедурная функция раздела «imap». Её отличают имя imap_listscan, контракт «обязательные $imap, $reference, $pattern, $content» и объявленный результат array|false; эти три признака нужно сверять вместе при выборе похожего API.

Смысловое направление imap_listscan

Смысловое направление imap_listscan — «получение данных». В прикладном коде различайте отсутствие данных, пустое значение и технический отказ источника. Контрольный набор для этой операции: проверьте пустой источник, один результат и недоступное окружение. Такой акцент отделяет imap_listscan от API с похожей сигнатурой, но противоположным действием или другим жизненным циклом.

Сигнатура imap_listscan

Структурная запись: array|false imap_listscan(IMAP\Connection $imap, string $reference, string $pattern, string $content). В ней 4 параметра: обязательные $imap, $reference, $pattern, $content. Результат объявлен как array|false; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры imap_listscan

Порядок и роли аргументов по сигнатуре: 1. $imap — IMAP\Connection, обязателен; 2. $reference — string, обязателен; 3. $pattern — string, обязателен; 4. $content — string, обязателен.

Контроль входных данных для imap_listscan

1) IMAP\Connection $imap — обязательный: подтвердите тип и открытое состояние ресурса, затем проверьте вызов после его закрытия. 2) string $reference — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной. 3) string $pattern — обязательный: испытайте корректный, пустой и синтаксически ошибочный шаблон или формат. 4) string $content — обязательный: разведите пустую строку, штатное значение и ввод с неожиданной кодировкой или длиной.

Результат imap_listscan

imap_listscan объявляет результат типа array|false. Контракт imap_listscan допускает false: проверяйте этот исход строгим сравнением === false, чтобы не спутать его с 0, пустой строкой или пустым массивом.

Проверочный сценарий для imap_listscan

Убедитесь, что раздел «imap» доступен в целевой сборке PHP. Сначала выполните контрольный вызов с обязательным набором IMAP\Connection $imap, string $reference, string $pattern, string $content. Необязательных аргументов в этой сигнатуре нет, поэтому меняйте только состояние окружения. Для профиля «сетевое взаимодействие» важно задавать таймауты и не считать транспортный успех бизнес-успехом; негативный сценарий должен проверить таймаут, недоступный узел и некорректный ответ.

Интеграция imap_listscan в проект

Проверку доступности imap_listscan и преобразование входных значений разместите у границы модуля «imap». Для профиля «сетевое взаимодействие» вынесите обработку отказа в одну ветку и добавьте к журналу имя операции, версию PHP и безопасные метаданные входа. Не применяйте оператор @: он скрывает диагностический сигнал, необходимый для разбора сбоя. Повторный вызов разрешайте только после явной проверки, что операция imap_listscan не создаёт нежелательный повторный эффект в вашем сценарии.

Диагностика imap_listscan

Сначала запишите точную сигнатуру array|false imap_listscan(IMAP\Connection $imap, string $reference, string $pattern, string $content) и фактические типы переданных значений. Затем подтвердите загрузку расширения «imap» в той же среде, где выполняется imap_listscan. Документация описывает ошибочный исход: отделите его от корректного пустого значения строгой проверкой и сохраните исходную диагностику. Для imap_listscan предусмотрите отдельный тест ветки false; не смешивайте её с 0 или пустой строкой.

Границы применения

Для категории «сетевое взаимодействие» применяйте отдельный негативный тест: проверить таймаут, недоступный узел и некорректный ответ. В production-коде важно задавать таймауты и не считать транспортный успех бизнес-успехом. Исходные предупреждения и примечания не копируются на эту страницу: перед решением, влияющим на совместимость или безопасность, сверяйте поведение в целевой версии PHP.

Когда выбирать imap_listscan

Выбор imap_listscan оправдан, когда одновременно выполнены три условия: 1) в сборке доступно расширение «imap»; 2) сигнатура содержит 4 аргумента: обязательных 4, необязательных 0; 3) вызывающему коду нужен результат array|false и действие «получение данных». Для профиля «сетевое взаимодействие» до интеграции отдельно подтвердите применимость правила: «undefined». Если хотя бы один пункт не выполняется, сравните контракт с imap_search: у него другое назначение, владелец или набор входных данных.

Сравнение imap_listscan с соседними API

Для imap_listscan базовый ориентир: получает список почтовых ящиков, имена которых содержат заданную строку; обязательные $imap, $reference, $pattern, $content; результат array|false. Сопоставление с опубликованными соседями: imap_search: получает сообщения, удовлетворяющие заданным критериям; вход — обязательные $imap, $criteria; необязательные $flags, $charset; результат — array|false. imap_getsubscribed: получает список всех почтовых ящиков, на которые оформлена подписка; вход — обязательные $imap, $reference, $pattern; результат — array|false. imap_lsub: получает список всех почтовых ящиков, на которые оформлена подписка; вход — обязательные $imap, $reference, $pattern; результат — array|false. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

Версии и ограничения

imap_listscan сверена по закреплённой ревизии php/doc-ru. Перед обновлением PHP повторите тесты типов, предупреждений и граничных значений для этой сущности. Не переносите выводы между версиями без повторного запуска минимального воспроизводимого примера для imap_listscan.

Связанные материалы