(Node.js) List IMAP Mailboxes with Reference

Demonstrates how to list all sub-mailboxes within a specified context. In this case, we list all mailboxes under "INBOX.vendors".

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

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

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("admin@chilkatsoft.com","myPassword");
    if (success !== true) {
        console.log(imap.LastErrorText);
        return;
    }

    // The ListMailboxes method returns a Mailboxes object
    // that contains the collection of mailboxes.
    // It accepts two arguments: a refName and a wildcardedMailbox.

    // List all mailboxes under INBOX.vendors
    var refName = "INBOX.vendors";

    // Select all mailboxes matching this pattern:
    var wildcardedMailbox = "*";

    // mboxes: Mailboxes
    var mboxes = imap.ListMailboxes(refName,wildcardedMailbox);
    if (imap.LastMethodSuccess == false) {
        console.log(imap.LastErrorText);
        return;
    }

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

    // Sample output looks like this:
    // INBOX.vendors.shareit
    // INBOX.vendors.paypal
    // INBOX.vendors.dell
    // INBOX.vendors.inMotion
    // INBOX.vendors.myhosting
    // INBOX.vendors.peer1

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


}

chilkatExample();