imap_mail_move

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

imap_mail_move — Move specified messages to a mailbox

Description

imap_mail_move ( resource $imap , string $message_nums , string $mailbox , int $flags = 0 ) : bool

Moves mail messages specified by message_nums to the specified mailbox.

Parameters

imap

An IMAP stream returned by imap_open().

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

Warning

Passing untrusted data to this parameter is insecure, unless imap.enable_insecure_rsh is disabled.

flags

flags is a bitmask and may contain the single option:

  • CP_UID - the sequence numbers contain UIDS

Return Values

Returns true on success or false on failure.

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.

See Also