(PHP 4, PHP 5, PHP 7, PHP 8)
imap_clearflag_full — メッセージのフラグをクリアする
$imap,$sequence,$flag,$options = 0
この関数は、指定したシーケンス sequence
のメッセージのフラグから、指定したフラグ flag
を削除します。
imapIMAP\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 resource が期待されていました。
|
| 8.0.0 |
options が無効な値の場合、
ValueError がスローされるようになりました。
これより前のバージョンでは、
警告が発生し、false を返していました。
|