imap_clearflag_full

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

imap_clearflag_full — Clears flags on messages

说明

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

This function causes a store to delete 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 unset are "\\Seen", "\\Answered", "\\Flagged", "\\Deleted", and "\\Draft" (as defined by » RFC2060)

options

options are a bit mask and 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 实例，之前接受有效的 `imap` resource。
8.0.0	A ValueError is now thrown on invalid `options` parameter values. Previously, a warning was emitted and the function returned `false`.

参见

imap_setflag_full() - Sets flags on messages

改进此页面

了解如何改进此页面 • 提交拉取请求 • 报告一个错误

＋添加备注

用户贡献的备注 1 note

down

-4

calmdown at abendstille dot at ¶

21 years ago

This function seems not to save the \\Seen flag permanently.

Testet on Win NT IIS 4.0 PHP 4.3 and imap-mail-server