Home > PHP > Function > IMAP > imap_renamemailbox()

imap_renamemailbox()

imap_renamemailbox - Rename an old mailbox to new mailbox

Syntax

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

Arguments

  • imap_stream - An IMAP stream returned by imap_open().
  • old_mbox - The old mailbox name, see imap_open() for more information
  • new_mbox - The new mailbox name, see imap_open() for more information

Description

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

Version

PHP 4, 5

Return value

Returns TRUE on success or FALSE on failure.