JavaScript

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". JavaScript

var success = false;

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

var imap = new CkImap();

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

// Get the list of mailboxes.
var refName = "";
var wildcardedMailbox = "*";
var subscribed = false;

var mboxes = new CkMailboxes();
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;
}

// 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();