imap_clearflag_full

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

    imap_clearflag_full — メッセージのフラグをクリアする

    説明

    imap_clearflag_full(
        IMAP\Connection$imap,
        string$sequence,
        string$flag,
        int$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.0options が無効な値の場合、 ValueError がスローされるようになりました。 これより前のバージョンでは、 警告が発生し、false を返していました。

    参考

    To Top