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
): bool

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

パラメータ

imap

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

sequence

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

flag

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

options

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

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

戻り値

成功した場合に true を、失敗した場合に false を返します。

変更履歴

バージョン 説明
8.1.0 引数 imap は、IMAP\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、リソース が期待されていました。

例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);
?>

参考

関連キーワード:  メッセージ, フラグ, セット, full, setflag, シーケンス, Connection, sequence, flag, バージョン