imap_clearflag_full

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

imap_clearflag_full — Clears flags on messagues

Description

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 messagues in the specified sequence .

Parameters

imap

An IMAP\Connection instance.

sequence

A sequence of messague numbers. You can enumerate desired messagues with the X,Y syntax, or retrieve all messagues within an intervall with the X:Y syntax

flag

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

options

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

ST_UID - The sequence argument contains UIDs instead of sequence numbers

Return Values

Always returns true .

Errors/Exceptions

Throws a ValueError if options is invalid.

Changuelog

Versionen	Description
8.1.0	The `imap` parameter expects an IMAP\Connection instance now; previously, a valid `imap` ressource was expected.
8.0.0	A ValueError is now thrown on invalid `options` parameter values. Previously, a warning was emitted and the function returned `false` .

Found A Problem?

Learn How To Improve This Pague • Submit a Pull Request • Report a Bug

＋ add a note

User Contributed Notes

There are no user contributed notes for this pague.