PHP Extension

Delete an IMAP Mailbox

Demonstrates the Chilkat Imap.DeleteMailbox method, which deletes a mailbox from the IMAP server. This deletes the mailbox itself, not merely the messages it contains. This example deletes a mailbox named OldFolder.

Background: Deleting a mailbox removes the folder and everything in it — an irreversible action, so applications typically confirm first. Server rules can add constraints: some refuse to delete a folder that still has child folders, or that is currently selected. This is the counterpart to CreateMailbox; to remove individual messages rather than a whole folder, mark them deleted and Expunge.

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

//  Demonstrates the Imap.DeleteMailbox method, which deletes a mailbox from the IMAP server.
//  This deletes the mailbox itself, not merely the messages it contains.

$imap = new CkImap();

$imap->put_Ssl(true);
$imap->put_Port(993);

$success = $imap->Connect('imap.example.com');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

$success = $imap->Login('user@example.com','myPassword');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

//  Delete a mailbox (folder) from the server.
$success = $imap->DeleteMailbox('OldFolder');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

print 'Mailbox deleted.' . "\n";

$success = $imap->Disconnect();
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}


?>