(JavaScript) List IMAP Mailboxes

List the mailboxes available within an IMAP account.

Note: This example requires Chilkat v11.0.0 or greater.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

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

// Login
success = imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

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 = "*";

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