imap_setflag_full
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_setflag_full — Sets flags on messages
Description
imap_setflag_full( IMAP\Connection $imap, string $sequence, string $flag, int $options = 0 ): bool
Causes a store to add the specified flag to the flags set for the messages in the specified sequence.
Parameters
-
imap -
An IMAP\Connection instance.
-
sequence -
A sequence of message numbers. You can enumerate desired messages with the
X,Ysyntax, or retrieve all messages within an interval with theX:Ysyntax -
flag -
The flags which you can set are
\Seen,\Answered,\Flagged,\Deleted, and\Draftas defined by » RFC2060. -
options -
A bit mask that may contain the single option:
-
ST_UID- The sequence argument contains UIDs instead of sequence numbers
-
Return Values
Returns true on success or false on failure.
Changelog
| Version | Description |
|---|---|
| 8.1.0 | The imap parameter expects an IMAP\Connection instance now; previously, a resource was expected. |
Examples
Example #1 imap_setflag_full() example
<?php
$mbox = imap_open("{imap.example.org:143}", "username", "password")
or die("can't connect: " . imap_last_error());
$status = imap_setflag_full($mbox, "2,5", "\\Seen \\Flagged");
echo gettype($status) . "\n";
echo $status . "\n";
imap_close($mbox);
?>
See Also
- imap_clearflag_full() - Clears flags on messages
© 1997–2021 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/function.imap-setflag-full.php
