imap_clearflag_full

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

imap_clearflag_full — Clears flags on messages

Descrição

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

This function causes a store to delete the specified flag to the flags set for the messages in the specified sequence.

Parâmetros

imap

Uma instância de IMAP\Connection.

sequence

A sequence of message numbers. You can enumerate desired messages with the X,Y syntax, or retrieve all messages within an interval with the X:Y syntax

flag

The flags which you can unset are "\\Seen", "\\Answered", "\\Flagged", "\\Deleted", and "\\Draft" (as defined by » RFC2060)

options

options are a bit mask and may contain the single option:

ST_UID - The sequence argument contains UIDs instead of sequence numbers

Valor Retornado

Sempre retorna true.

Erros/Exceções

Throws a ValueError if options is invalid.

Registro de Alterações

Versão	Descrição
8.1.0	O parâmetro `imap` agora espera uma instância de IMAP\Connection; anteriormente, um resource `imap` válido era esperado.
8.0.0	A ValueError is now thrown on invalid `options` parameter values. Previously, a warning was emitted and the function returned `false`.

Veja Também

imap_setflag_full() - Sets flags on messages

add a note

User Contributed Notes 5 notes

down

Nohado ¶

14 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 ¶

7 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 ¶

15 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