PHP Extension

Unsubscribe from an IMAP Mailbox

Demonstrates the Chilkat Imap.Unsubscribe method, which removes the subscription to a mailbox. The mailbox itself and its messages are not deleted. This example unsubscribes from a mailbox.

Background: Unsubscribing simply drops a mailbox from the account's subscription list, so clients that show only subscribed folders will stop displaying it — the folder and everything in it remain on the server untouched. This is the counterpart to Subscribe, and is how you declutter a mailbox listing without deleting anything (deleting a folder is DeleteMailbox).

Chilkat PHP Extension Downloads

Download Chilkat for PHP Extension

PHP Extension

<?php

include("chilkat.php");

$success = false;

//  Demonstrates the Imap.Unsubscribe method, which removes the subscription to a mailbox.
//  The mailbox itself and its messages are not deleted.

$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;
}

//  Remove the subscription to a mailbox (the mailbox is not deleted).
$success = $imap->Unsubscribe('Archive2026');
if ($success == false) {
    print $imap->lastErrorText() . "\n";
    exit;
}

print 'Unsubscribed from the mailbox.' . "\n";

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


?>