array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'ja', ), 'this' => array ( 0 => 'function.imap-setflag-full.php', 1 => 'imap_setflag_full', ), 'up' => array ( 0 => 'ref.imap.php', 1 => 'IMAP 関数', ), 'prev' => array ( 0 => 'function.imap-setacl.php', 1 => 'imap_setacl', ), 'next' => array ( 0 => 'function.imap-sort.php', 1 => 'imap_sort', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'ja', 'path' => 'reference/imap/functions/imap-setflag-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_setflag_full — メッセージにフラグをセットする
この関数は、指定した 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 リソース が期待されていました。
|
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);
?>