imap_mail_move

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

imap_mail_move指定されたメッセージをメールボックスに移動する

説明

imap_mail_move ( resource $imap , string $message_nums , string $mailbox , int $flags = 0 ) : bool

message_nums で指定されたメッセージを、 指定されたメールボックス mbox に移動します。

パラメータ

imap

imap_open() が返す IMAP ストリーム。

message_nums

message_nums は、 (» RFC2060 に記述されたように) ただのメッセージ番号ではなく、範囲を示します。

mailbox

メールボックス名。詳細は imap_open() を参照ください。

警告

信頼できないデータをこのパラメータに渡すのであれば、 imap.enable_insecure_rsh を無効にしておかなければ危険です。

flags

flags はビットマスクであり、ひとつのオプションをとります。

  • CP_UID - UIDS を含む処理の数

返り値

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

注意

注意:

imap_mail_move() は元のメールに削除フラグを立てます。 imap_expunge() がコールされたときに確実に削除されるようにするためです。

参考

  • imap_mail_copy() - 指定されたメッセージをメールボックスにコピーする