Node.js

Subscribe to Mailboxes and List Subscribed Mailboxes

See more IMAP Examples

Demonstrates how to list subscribed mailboxes, and unsubscribe/subscribe to a mailbox. Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    var imap = new chilkat.Imap();

    // Connect to an IMAP server.
    // Use TLS
    imap.Ssl = true;
    imap.Port = 993;
    success = imap.Connect("imap.example.com");
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    // Login
    success = imap.Login("myLogin","myPassword");
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    // First examine the already subscribed mailboxes.
    var refName = "";
    var wildcardedMailbox = "*";
    var subscribed = true;

    var mboxes = new chilkat.Mailboxes();
    success = imap.MbxList(subscribed,refName,wildcardedMailbox,mboxes);
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    var i = 0;
    while (i < mboxes.Count) {
        console.log(mboxes.GetName(i));
        i = i+1;
    }

    console.log("----");

    // Sample output.

    // INBOX
    // INBOX/recent
    // INBOX/misc
    // INBOX/misc/solutions
    // ...
    // Outbox
    // Deleted Items
    // Sent Items
    // Drafts
    // Junk E-mail
    // Trash
    // Sent
    // Templates

    // Let's unsubscribe to "INBOX/misc/solutions".
    success = imap.Unsubscribe("INBOX/misc/solutions");
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    // Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
    success = imap.MbxList(subscribed,"","INBOX/misc*",mboxes);
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    i = 0;
    while (i < mboxes.Count) {
        console.log(mboxes.GetName(i));
        i = i+1;
    }

    console.log("----");

    // Re-subscribe to "INBOX/misc/solutions".
    success = imap.Subscribe("INBOX/misc/solutions");
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    // Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
    success = imap.MbxList(subscribed,"","INBOX/misc*",mboxes);
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    i = 0;
    while (i < mboxes.Count) {
        console.log(mboxes.GetName(i));
        i = i+1;
    }

    console.log("----");

    // Disconnect from the IMAP server.
    success = imap.Disconnect();

}

chilkatExample();