JavaScript

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).

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

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

var imap = new CkImap();

imap.Ssl = true;
imap.Port = 993;

success = imap.Connect("imap.example.com");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

success = imap.Login("user@example.com","myPassword");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

//  Remove the subscription to a mailbox (the mailbox is not deleted).
success = imap.Unsubscribe("Archive2026");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

console.log("Unsubscribed from the mailbox.");

success = imap.Disconnect();
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}