What is PhpDig?
PhpDig is a PHP MySQL based
Web Spider & Search Engine.

imap_renamemailbox
Prev	XXXI. IMAP Functions	Next

imap_renamemailbox

Name

imap_renamemailbox — Renames a maibox

Synopsis

int imap_renamemailbox(connection, current, new); int connection: IMAP Connection ID string current: Current mailbox name string new: New mailbox name

Returns

TRUE on sucess; FALSE on error

Description

Renames a mailbox from the current exisiting name to the new specified one.

Version

From versions 3.0 and 4.0

Example

Example 616. Rename mailbox

<?php
$imap = imap_open("{localhost}INBOX","graeme","inferno");

$mailbox = "test_mailbox";
$new_mailbox = "test_newmailbox";

if (!imap_createmailbox($imap,"{localhost}$mailbox")) {
   echo "Unable to create new mailbox!\n";
   echo imap_last_error(); 
}

// list the mailboxs to show it's there 
$boxes = imap_listmailbox($imap, "{localhost}", "test*");
echo "<b>Mailboxes:</b><BR>\n";
for ($i=0; $i<count($boxes); $i++) {
   echo "Mailbox: $boxes[$i]<BR>\n";
}

// now rename it
if (!imap_renamemailbox($imap, "{localhost}$mailbox", "{localhost}$new_mailbox")) {
   echo "Unable to delete mailbox!\n";
   echo imap_last_error(); 
}

// now relist to prove a point
$boxes = imap_listmailbox($imap, "{localhost}", "test*");
echo "<b>Mailboxes:</b><BR>\n";
for ($i=0; $i<count($boxes); $i++) {
   echo "Mailbox: $boxes[$i]<BR>\n";
}

imap_close($imap);
?>

Output:
Mailboxes:
Mailbox: {localhost}test_mailbox

Mailboxes:
Mailbox: {localhost}test_newmailbox

Prev	Home	Next
imap_popen	Up	imap_reopen

PHP Functions Essential Reference. Copyright © 2002 by New Riders Publishing (Authors: Zak Greant, Graeme Merrall, Torben Wilson, Brett Michlitsch). This material may be distributed only subject to the terms and conditions set forth in the Open Publication License, v1.0 or later (the latest version is presently available at http://www.opencontent.org/openpub/). The authors of this book have elected not to choose any options under the OPL. This online book was obtained from http://www.fooassociates.com/phpfer/ and is designed to provide information about the PHP programming language, focusing on PHP version 4.0.4 for the most part. The information is provided on an as-is basis, and no warranty or fitness is implied. All persons and entities shall have neither liability nor responsibility to any person or entity with respect to any loss or damage arising from the information contained in this book.