PHP

Rename an IMAP Mailbox

Demonstrates the Chilkat Imap.RenameMailbox method, which renames a mailbox from the first name to the second. Changing the hierarchy components in the new name can also move a mailbox within the server's folder tree. This example renames OldName to NewName.

Background: Because a mailbox's full name encodes its place in the folder hierarchy, renaming is also how you move a folder: renaming Inbox/Draft to Archive/Draft relocates it under a different parent. The messages inside move along with the folder. This makes RenameMailbox the tool for both relabeling and reorganizing an account's folder structure.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Imap;

// Demonstrates the Imap.RenameMailbox method, which renames a mailbox.  Changing hierarchy
// components can also move a mailbox within the server's folder tree.

$imap = new Imap();

$imap->Ssl = true;
$imap->Port = 993;

try {
    $imap->Connect('imap.example.com');

    $imap->Login('user@example.com', 'myPassword');

    // Rename a mailbox from "OldName" to "NewName".
    $imap->RenameMailbox('OldName', 'NewName');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo "Mailbox renamed.\n";

try {
    $imap->Disconnect();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}