IMAP_SETFLAG_FULL(3) 1 IMAP_SETFLAG_FULL(3)
imap_setflag_full - Sets flags on messages
SYNOPSIS
bool imap_setflag_full (resource $imap_stream, string $sequence, string $flag, [int $options = NIL])
DESCRIPTION
Causes a store to add the specified $flag to the flags set for the messages in the specified $sequence.
PARAMETERS
o $
imap_stream -An IMAP stream returned by imap_open(3).
o $sequence
- A sequence of message numbers. You can enumerate desired messages with the X,Y syntax, or retrieve all messages within an inter-
val with the X:Y syntax
o $flag
- The flags which you can set are Seen, Answered, Flagged, Deleted, and Draft as defined by RFC2060.
o $options
- A bit mask that may contain the single option:
o ST_UID - The sequence argument contains UIDs instead of sequence numbers
RETURN VALUES
Returns TRUE on success or FALSE on failure.
EXAMPLES
Example #1
imap_setflag_full(3) 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) . "
";
echo $status . "
";
imap_close($mbox);
?>
SEE ALSO
imap_clearflag_full(3).
PHP Documentation Group IMAP_SETFLAG_FULL(3)