(Node.js) List IMAP Mailboxes

List the mailboxes available within an IMAP account.

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("MY-IMAP-DOMAIN");
    if (success !== true) {
        console.log(imap.LastErrorText);
        return;
    }

    // Login
    success = imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD");
    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.

    var refName = "";
    // refName is usually set to an empty string.
    // A non-empty reference name argument is the name of a mailbox or a level of
    // mailbox hierarchy, and indicates the context in which the mailbox
    // name is interpreted.

    // 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.oldSupport
    // INBOX.vendors.paypal
    // INBOX.sales
    // INBOX.lists
    // INBOX.Drafts
    // INBOX.vendors.dell
    // INBOX.Trash
    // INBOX.invoiceRequests
    // INBOX.purchases
    // INBOX.vendors.inMotion
    // INBOX.oldEmail
    // INBOX.vendors
    // INBOX.lists.python
    // INBOX.vendors.myhosting
    // INBOX.Templates
    // INBOX.friends
    // INBOX.bounceSamples
    // INBOX.lists.ruby
    // INBOX.vendors.peer1
    // INBOX.Sent
    // INBOX.Junk
    // INBOX

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


}

chilkatExample();