imap_setflag_full

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

imap_setflag_full — メッセージにフラグをセットする

説明

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

この関数は、指定した sequence のメッセージのフラグに指定した flag を設定し、保存します。

パラメータ

imap

IMAP\Connection クラスのインスタンス。

sequence

メッセージ番号のシーケンス。 X,Y 形式でメッセージを列挙したり、 X:Y 形式で範囲内のすべてのメッセージを指定したりすることができます。

flag

設定可能なフラグは、(» RFC2060 で定義された) \Seen、 \Answered、\Flagged、 \Deleted および \Draft です。

options

options はビットマスクであり、以下の組み合わせとなります。

ST_UID - シーケンス引数はシーケンス番号の代わりに UID を含みます。

戻り値

常に true を返します。

エラー / 例外

options が無効な場合、 ValueError がスローされます。

変更履歴

バージョン	説明
8.1.0	引数 `imap` は、IMAP\Connection クラスのインスタンスを期待するようになりました。これより前のバージョンでは、有効な `imap` resource が期待されていました。
8.0.0	`options` が無効な値の場合、 ValueError がスローされるようになりました。これより前のバージョンでは、警告が発生し、`false` を返していました。

例

例1 imap_setflag_full() の例

<?php
$mbox = imap_open("{imap.example.org:143}", "username", "password")
     or die("接続できません: " . imap_last_error());

$status = imap_setflag_full($mbox, "2,5", "\\Seen \\Flagged");

echo gettype($status) . "\n";
echo $status . "\n";

imap_close($mbox);
?>

参考

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