imap_delete

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

imap_delete — Позначає повідомлення для видалення

Опис

imap_delete(IMAP\Connection $imap, string $message_nums, int $flags = 0): true

Позначає повідомлення, перелічені у message_nums для видалення. Позначені повідомлення залишатимуться в скриньці доки не буде викликана функція imap_expunge(), либоimap_close() із встановленим параметром CL_EXPUNGE

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

imap

Екземпляр IMAP\Connection

message_nums

Рядок (string), що складається з одного або декількох повідомлень у форматі послідовності у стилі IMAP4 ("n" "n:m" або їх комбінація, розділена комами).

flags

Можна поставити як **FT_UID**тоді функція буде очікувати в параметрі message_nums не номер повідомлення, а UID

Значення, що повертаються

Функція завжди повертає true

Помилки

Викидає виняток ValueError, если значение параметраflagsнедопустимо.

список змін

Версия	Опис
8.1.0	Параметрimap тепер чекає екземпляр IMAP\Connection; раніше очікувався ресурс (resourceimap
8.0.0	Тепер викидається винятокValueError, при неприпустимих значеннях параметра flags. . Раніше виникало попередження та функція повертала логічне значення false

Приклади

Приклад #1 Приклад використання imap_delete()****

Loading...
▶

Примітки

Зауваження :

Скриньки IMAP можуть не зберігати прапори між з'єднаннями, отже якщо ви дійсно хочете видалити позначені повідомлення, необхідно викликати imap_expunge() у тому ж з'єднанні, в якому встановлювалися прапори.

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

• imap_undelete() - Знімає з повідомлення позначку видалення
• imap_expunge() - Видаляє всі позначені для видалення повідомлення
• imap_close() - Закриває потік IMAP