PHP Conference Japan 2024

imap_clearflag_full

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

imap_clearflag_full清除訊息上的旗標

說明

imap_clearflag_full(
    IMAP\Connection $imap,
    字串 $sequence,
    字串 $flag,
    整數 $options = 0
): true

此函式會導致存放區刪除指定 sequence 中訊息的旗標集中指定的 flag

參數

imap

一個 IMAP\Connection 實例。

sequence(序列)

訊息編號的序列。您可以使用 X,Y 語法列舉所需的訊息,或使用 X:Y 語法擷取區間內的所有訊息。

flag(旗標)

您可以取消設定的旗標有 "\\Seen"(已讀)、"\\Answered"(已回覆)、"\\Flagged"(已標記)、"\\Deleted"(已刪除)和 "\\Draft"(草稿)(根據 » RFC2060 的定義)。

options(選項)

options 是一個位元遮罩,可以包含單個選項

  • ST_UID - 序列參數包含 UID 而不是序列號。

返回值

總是返回 true

錯誤/例外

如果 options 無效,則會拋出 ValueError

更新日誌

版本 說明
8.1.0 imap 參數現在需要一個 IMAP\Connection 實例;以前,需要一個有效的 imap 資源
8.0.0 現在,如果 options 參數值無效,則會拋出 ValueError。以前,會發出警告,且函數返回 false

另請參閱

新增註記

使用者貢獻的註記

此頁面沒有使用者貢獻的註記。
To Top