Home > PHP > Function > IMAP > imap_setflag_full()

imap_setflag_full()

imap_setflag_full - Sets flags on messages

Syntax

bool imap_setflag_full (resource $imap_stream, string $sequence, string $flag, int $options)

Arguments

  • imap_stream - An IMAP stream returned by imap_open().
  • sequence - A sequence of message numbers. You can enumerate desired messages with the X,Ysyntax, or retrieve all messages within an interval with the X: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

Description

Causes a store to add the specified flag to the flags set for the messages in the specified sequence.

Version

PHP 4, 5

Return value

Returns TRUE on success or FALSE on failure.