imap_clearflag_full

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

imap_clearflag_fullСнимает с сообщения установленные флаги

Описание

imap_clearflag_full(
    IMAP\Connection $imap,
    string $sequence,
    string $flag,
    int $options = 0
): true

Эта функция оповещает хранилище, что необходимо снять заданный флаг flag для указанной последовательности сообщений sequence.

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

imap

Экземпляр класса IMAP\Connection.

sequence

Последовательность номеров сообщений. Вы можете перечислить номера через запятую X,Y, или задать диапазон номеров с помощью двоеточия X:Y

flag

Флаги, которые можно удалить: "\\Seen", "\\Answered", "\\Flagged", "\\Deleted" и "\\Draft" (как определено в » RFC2060)

options

options - битовая маска, которая может принимать единственное значение:

  • ST_UID - аргумент sequence содержит список UID, а не последовательность номеров

Возвращаемые значения

Функция возвращает логическое значение true.

Ошибки

Выбрасывает исключение ValueError, если значение параметра options недопустимо.

Список изменений

Версия Описание
8.1.0 Параметр imap теперь ожидает экземпляр класса IMAP\Connection; раньше параметр ждал ресурс (resource) imap.
8.0.0 Теперь выбрасывается исключение ValueError при недопустимых значениях параметра options. Ранее возникало предупреждение и функция возвращала логическое значение false.

Смотрите также

Добавить

Примечания пользователей 1 note

up
-4
calmdown at abendstille dot at
21 years ago
This function seems not to save the \\Seen flag permanently.

Testet on Win NT IIS 4.0 PHP 4.3 and imap-mail-server
To Top