imap_expunge — Удаляет все помеченные для удаления сообщения

Назначение imap_expunge

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

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

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

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

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

Сигнатура imap_expunge

Структурная запись: true imap_expunge(IMAP\Connection $imap). В ней 1 параметр: обязательные $imap. Результат объявлен как true; перед переносом кода сопоставьте сигнатуру с версией PHP и составом расширений проекта.

Параметры imap_expunge

Порядок и роли аргументов по сигнатуре: 1. $imap — IMAP\Connection, обязателен. Для imap_expunge фиксируйте фактические типы входа в тесте и отдельно проверяйте значения на границе допустимого диапазона.

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

1) IMAP\Connection $imap — обязательный: подтвердите тип и открытое состояние ресурса, затем проверьте вызов после его закрытия.

Результат imap_expunge

imap_expunge объявляет результат типа true. Результат imap_expunge имеет объявленный тип true. После вызова проверяйте именно этот контракт и отдельно фиксируйте документированные ошибочные исходы.

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

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

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

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

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

Сначала запишите точную сигнатуру true imap_expunge(IMAP\Connection $imap) и фактические типы переданных значений. Затем подтвердите загрузку расширения «imap» в той же среде, где выполняется imap_expunge. Если результат неожиданен, сравните его тип с true и воспроизведите вызов на минимальном входе без подавления предупреждений. После исправления повторите штатный и граничный сценарии, чтобы исключить маскировку ошибки случайным успешным результатом.

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

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

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

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

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

Для imap_expunge базовый ориентир: удаляет все помеченные для удаления сообщения; обязательные $imap; результат true. Сопоставление с опубликованными соседями: imap_undelete: снимает с сообщения метку удаления; вход — обязательные $imap, $message_nums; необязательные $flags; результат — true. imap_delete: помечает сообщение для удаления; вход — обязательные $imap, $message_nums; необязательные $flags; результат — true. imap_setflag_full: устанавливает флаги на сообщения; вход — обязательные $imap, $sequence, $flag; необязательные $options; результат — true. Выбор делайте по различиям владельца, контракта и жизненного цикла, а не по сходству имени.

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

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

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