imap_undelete

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

imap_undelete削除マークがついているメッセージのマークをはずす

説明

imap_undelete(IMAP\Connection $imap, string $message_nums, int $flags = 0): bool

指定したメッセージについて、 imap_delete() または imap_mail_move() で設定された削除フラグをはずします。

パラメータ

imap

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

message_nums

IMAP4 形式のシーケンスフォーマット ("n", "n:m", またはそれらをカンマで区切ったもの) で表現された、ひとつ以上のメッセージを表す文字列。

flags

戻り値

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

変更履歴

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

参考

  • imap_delete() - 現在のメールボックスから削除するメッセージに印を付ける
  • imap_mail_move() - 指定されたメッセージをメールボックスに移動する

関連キーワード:  メッセージ, マーク, 削除, undelete, Connection, mail, メールボックス, 期待, バージョン, インスタンス