Node.js

List and Inspect IMAP Mailboxes

Demonstrates the Chilkat Mailboxes class, a read-only result collection populated by Imap.MbxList. This example connects to an IMAP server, lists all mailboxes into a Mailboxes object, then loops from 0 to Count - 1 and inspects each mailbox: its name (GetName), whether it is selectable (IsSelectable) or marked (IsMarked), whether it may have child mailboxes (HasInferiors), a specific flag (HasFlag), and all of its flags both as a string (GetFlags) and individually (GetNumFlags with GetNthFlag). Finally it looks up a mailbox by name with GetMailboxIndex.

Background: Mailboxes is how an application renders an IMAP folder tree. Because it is read-only, you never construct it directly — you receive it from MbxList and read its entries by index. Mailbox names come back as normal Unicode text (Chilkat handles the modified UTF-7 / IMAP UTF-8 encoding at the protocol level), so a name from GetName can be passed straight to methods like SelectMailbox. Note that HasInferiors is often true: it means children exist or may be created, which is not the same as \HasChildren.

Chilkat Node.js Downloads

Download Chilkat for Node.js

Node.js

NODEJS_PRELUDE

function chilkatExample() {

    var success = false;

    //  Demonstrates using Chilkat.Imap to populate a Mailboxes object (via MbxList), then looping
    //  over the collection to inspect each mailbox's name and attributes.  Mailboxes is a read-only
    //  result collection -- applications inspect the entries but do not add, remove, or modify them.

    var imap = new chilkat.Imap();

    imap.Ssl = true;
    imap.Port = 993;

    success = imap.Connect("imap.example.com");
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    success = imap.Login("user@example.com","myPassword");
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    //  Populate a Mailboxes object with the full list of mailboxes.  The first argument requests
    //  all mailboxes (not subscribed-only) and "*" matches any name.
    var subscribedOnly = false;
    var mailboxes = new chilkat.Mailboxes();
    success = imap.MbxList(subscribedOnly,"","*",mailboxes);
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }

    //  Loop over each mailbox in the returned collection.
    var n = mailboxes.Count;
    console.log("Number of mailboxes: " + n);

    var i;
    for (i = 0; i <= n - 1; i++) {
        var name = mailboxes.GetName(i);
        console.log("Mailbox: " + name);

        //  Whether the mailbox can be selected or examined for message access.
        if (mailboxes.IsSelectable(i)) {
            console.log("  Selectable: yes");
        }
        else {
            console.log("  Selectable: no");
        }

        //  Whether the server marked the mailbox as possibly having new messages.
        if (mailboxes.IsMarked(i)) {
            console.log("  Marked: yes");
        }

        //  Whether the mailbox has, or may contain, child mailboxes.
        if (mailboxes.HasInferiors(i)) {
            console.log("  May have child mailboxes");
        }

        //  Check for a specific flag by name.  Include the leading backslash for a system flag;
        //  in CkScript a literal backslash in a string is written as "\\".
        if (mailboxes.HasFlag(i,"\\HasChildren")) {
            console.log("  Has child mailboxes");
        }

        //  Get all of the mailbox's flags as a comma-separated string.
        var flags = mailboxes.GetFlags(i);
        console.log("  Flags: " + flags);

        //  Iterate the flags individually.
        var numFlags = mailboxes.GetNumFlags(i);
        var j;
        for (j = 0; j <= numFlags - 1; j++) {
            var flag = mailboxes.GetNthFlag(i,j);
            console.log("    Flag " + j + ": " + flag);
        }

    }

    //  Look up a mailbox by name.  Returns -1 if no mailbox with that name is present.
    var sentIndex = mailboxes.GetMailboxIndex("Sent");
    if (sentIndex >= 0) {
        console.log("The Sent mailbox is at index " + sentIndex);
    }

    success = imap.Disconnect();
    if (success == false) {
        console.log(imap.LastErrorText);
        return;
    }


}

chilkatExample();