(Node.js) Subscribe to Mailboxes and List Subscribed Mailboxes

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

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOS

var os = require('os');
if (os.platform() == 'win32') {  
  var chilkat = require('@chilkat/ck-node23-win64'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node23-linux-arm');
    } else if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node23-linux-arm64');
    } else {
        var chilkat = require('@chilkat/ck-node23-linux-x64');
    }
} else if (os.platform() == 'darwin') {
  var chilkat = require('@chilkat/ck-node23-mac-universal');
}

function chilkatExample() {

    // 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;
    var success = imap.Connect("imap.someMailServer.com");
    if (success !== true) {
        console.log(imap.LastErrorText);
        return;
    }

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

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

    // Alternatively, the ListMailboxes method can be called to list all mailboxes (both subscribed and unsubscribed).
    // mboxes: Mailboxes
    var mboxes = imap.ListSubscribed(refName,wildcardedMailbox);
    if (imap.LastMethodSuccess !== true) {
        console.log(imap.LastErrorText);
        return;
    }

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

    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 !== true) {
        console.log(imap.LastErrorText);
        return;
    }

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

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

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

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

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

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

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

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

}

chilkatExample();