Home/ Manual/ imap / functions/ imap_mail_copy

imap_mail_copy

PHP function Edit on GitHub ✎

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

Copy specified messages to a mailbox

Description

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

Copies mail messages specified by message_nums to specified mailbox.

message_nums

message_nums is a range not just message numbers (as described in RFC2060).

mailbox

The mailbox name, see imap_open() for more information

Insecure

flags

flags is a bitmask of one or more of

CP_UID - the sequence numbers contain UIDS
CP_MOVE - Delete the messages from the current mailbox after copying. If this flag is set, the function behaves identically to imap_mail_move().

Success

Version	Description