imap_mail_move(3) php man page | unix.com

IMAP_MAIL_MOVE(3)							 1							 IMAP_MAIL_MOVE(3)

imap_mail_move - Move specified messages to a mailbox

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

DESCRIPTION
	Moves mail messages specified by $msglist to the specified $mailbox.

PARAMETERS
	      o $
		imap_stream -An IMAP stream returned by imap_open(3).

	      o $msglist
		-$msglist is a range not just message numbers (as described in RFC2060).

	      o $mailbox
		- The mailbox name, see imap_open(3) for more information

	      o $options
		-$options is a bitmask and may contain the single option:

		     o CP_UID - the sequence numbers contain UIDS

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

NOTES
       Note

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

SEE ALSO
       imap_mail_copy(3).

PHP Documentation Group 													 IMAP_MAIL_MOVE(3)