array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ja', ), 'this' => array ( 0 => 'function.imap-clearflag-full.php', 1 => 'imap_clearflag_full', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'IMAP 関数', ), 'prev' => array ( 0 => 'function.imap-check.php', 1 => 'imap_check', ), 'next' => array ( 0 => 'function.imap-close.php', 1 => 'imap_close', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ja', 'path' => 'reference/imap/functions/imap-clearflag-full.xml', ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); ?>
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_clearflag_full — メッセージのフラグをクリアする
この関数は、指定したシーケンス 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 を返していました。
|