php man page for imap_renamemailbox

IMAP_RENAMEMAILBOX(3)							 1						     IMAP_RENAMEMAILBOX(3)

imap_renamemailbox - Rename an old mailbox to new mailbox

SYNOPSIS
       bool imap_renamemailbox (resource  $imap_stream, string	$old_mbox, string  $new_mbox)

DESCRIPTION
	This function renames on old mailbox to new mailbox (see imap_open(3) for the format of $mbox names).

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

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

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

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

SEE ALSO
       imap_createmailbox(3), imap_deletemailbox(3).

PHP Documentation Group 												     IMAP_RENAMEMAILBOX(3)