imap_setflag_full

    (PHP 4, PHP 5, PHP 7, PHP 8)

    imap_setflag_full — Sets flags on messages

    说明

    imap_setflag_full(
        IMAP\Connection$imap,
        string$sequence,
        string$flag,
        int$options = 0
    ): true

    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,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。

    错误／异常

    Throws a ValueError if options is invalid.

    更新日志

    版本说明
    8.1.0 现在 imap 参数接受 IMAP\Connection 实例，之前接受有效的 imapresource。
    8.0.0 A ValueError is now thrown on invalid options parameter values. Previously, a warning was emitted and the function returned false.

    示例

    示例 #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);
    ?>

    参见

    To Top