imap_mail_copy

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

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

説明

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

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

パラメータ

imap

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

message_nums

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

mailbox

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

警告

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

flags

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

  • CP_UID - UIDS を含む処理の数
  • CP_MOVE - コピー後にメールボックスからメッセージを削除する。 このフラグが設定されていると、この関数は imap_mail_move() と同じ振る舞いをします。

戻り値

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

変更履歴

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

参考

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

関連キーワード:  メールボックス, メッセージ, コピー, mail, 指定, nums, flags, copy, Connection, バージョン