imap_setflag_full
(PHP 4, PHP 5, PHP 7)
imap_setflag_full — Sets flags on messages
说明
imap_setflag_full (
resource
$imap_stream
,
string $sequence
,
string $flag
[,
int $options
= NIL ] ) :
bool
Causes a store to add the specified flag
to the flags set for the messages in the specified sequence
.
参数
-
imap_stream
-
由 imap_open() 返回的 IMAP 流。
-
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 set are \Seen, \Answered, \Flagged, \Deleted, and \Draft as defined by » RFC2060.
-
options
-
A bit mask that may contain the single option:
-
ST_UID
- The sequence argument contains UIDs instead of sequence numbers
-
返回值
成功时返回 TRUE
, 或者在失败时返回 FALSE
。
范例
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);
?>