Home > PHP > Function > IMAP > imap_mail_move()

imap_mail_move()

imap_mail_move - Move specified messages to a mailbox

Syntax

bool imap_mail_move (resource $imap_stream, string $msglist, string $mailbox, int $options)

Arguments

  • imap_stream - An IMAP stream returned by imap_open().
  • msglist - msglist is a range not just message numbers (as described in » RFC2060).
  • mailbox - The mailbox name, see imap_open() for more information
  • options - options is a bitmask and may contain the single option: CP_UID - the sequence numbers contain UIDS

Description

Moves mail messages specified by msglist to the specified mailbox.

Version

PHP 4, 5

Return value

Returns TRUE on success or FALSE on failure.