imap_mail_move

Move specified messages to a mailbox

&reftitle.description; `bool` `imap_mail_move` `IMAP\Connection` `imap` `string` `message_nums` `string` `mailbox` `int` `flags` 0

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.

&reftitle.parameters;

&imap.imap-parameter.imap;

`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

  &imap.mailboxname.insecure;

`flags`

- `flags` is a bitmask and may contain the single option:

  - `CP_UID` - the sequence numbers contain UIDS

&reftitle.returnvalues;

&return.success;

&reftitle.changelog;

&Version; | &Description;
&imap.changelog.imap-param;

&reftitle.notes;

`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.

&reftitle.seealso;

- `imap_mail_copy`