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`.

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

imap_setflag_full() - Устанавливает флаги на сообщения

add a note

User Contributed Notes 5 notes

down

Nohado ¶

13 years ago


I got a note that:

if u want to set a mail to "//Unseen", which not exists,
do it like this:

imap_clearflag_full($your_imap_connection,
$number_of_message,"//Seen");

but, remember to do
imap_close($imap, CL_EXPUNGE);
@ the END! so that it will be confirmed!

Cheers,
Nohado

down

-1

info at sharoff dot org ¶

6 years ago


<?php 

$connection = imap_open(...);
$messageUid = 123;

imap_clearflag_full($connection, $messageUid, '\\Seen', ST_UID);

down

-1

Anonymous ¶

18 years ago


imap_clearflag_full() and imap_setflag_full() seem to only change messageflags permanently with IMAP connections, not with POP3 connections.

down

-2

Mark Hill ¶

14 years ago


Remember to specify your flags like '\\Seen' rather than "\\Seen".

Of course, flags are an IMAP feature, not a POP feature.

Resetting \\Seen works from PHP 4.3 works fine on the modern mail servers I've tested.

down

-3

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

add a note