imap_mail_move

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

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

説明

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

message_nums で指定されたメッセージを、指定されたメールボックス mbox に移動します。実際には mailbox にメッセージが コピー され、オリジナルのメッセージには削除済みのフラグが付く点に注意して下さい。これは、mailbox にあるメッセージには、新しい UID が割り当てられるということです。

パラメータ

imap

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

message_nums

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

mailbox

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

警告

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

flags

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

CP_UID - UIDS を含む処理の数

戻り値

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

変更履歴

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