Home/ Manual/ imap / functions/ imap_mail_move

imap_mail_move

PHP function Edit on GitHub ✎

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

Move specified messages to a mailbox

Description

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

Moves mail messages specified by message_nums to the specified mailbox. Note that the mail messages are actually copied to the mailbox, and the original messages are flagged for deletion. That implies that the messages in mailbox are assigned new UIDs.

Parameters

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 and may contain the single option:

CP_UID - the sequence numbers contain UIDS

Return Values

Success

Changelog

Version	Description

Notes

Note

imap_mail_move() will flag the original mail with a delete flag, to successfully delete it a call to the imap_expunge() function must be made.