array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'function.imap-clearflag-full.php', 1 => 'imap_clearflag_full', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'IMAP Functions', ), 'prev' => array ( 0 => 'function.imap-check.php', 1 => 'imap_check', ), 'next' => array ( 0 => 'function.imap-close.php', 1 => 'imap_close', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/imap/functions/imap-clearflag-full.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_clearflag_full — Clears flags on messages
This function causes a store to delete the specified
flag
to the flags set for the
messages in the specified sequence
.
imap
An IMAP\Connection instance.
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
Always returns true
.
Throws a ValueError if options
is invalid.
Version | Description |
---|---|
8.1.0 |
The imap parameter expects an IMAP\Connection
instance now; previously, a valid imap resource 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 .
|