imap_mail_copy
(PHP 4, PHP 5, PHP 7, PHP 8)
imap_mail_copy — Copy specified messages to a mailbox
Description
Copies mail messages specified by message_nums
to specified mailbox.
Parameters
-
imap
-
An IMAP\Connection instance.
-
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
WarningPassing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.
-
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().
-
Return Values
Returns true
on success or false
on failure.
Changelog
Version | Description |
---|---|
8.1.0 |
The imap parameter expects an IMAP\Connection
instance now; previously, a resource was expected.
|