imap_setflag_full
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_setflag_full — Sets flags on messages
說明
imap_setflag_full(
IMAP\Connection
string
string
int
): bool
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.
參數
-
imap -
IMAP\Connection 實例。
-
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
-
返回值
成功時返回 true, 或者在失敗時返回 false。
更新日誌
| 版本 | 說明 |
|---|---|
| 8.1.0 |
現在 imap 參數接受 IMAP\Connection
實例,之前接受 資源(resource)。
|
範例
示例 #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);
?>