Java

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 Java Downloads

Download Chilkat for Java

Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Imap;
import com.chilkatsoft.chilkat2.Mailboxes;

public class ChilkatExample {

    public static void main(String[] args) {
        // 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.

        Imap imap = new Imap();

        imap.setSsl(true);
        imap.setPort(993);

        try {
            imap.connect("imap.example.com");

            imap.login("user@example.com", "myPassword");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Populate a Mailboxes object with the full list of mailboxes.  The first argument requests
        // all mailboxes (not subscribed-only) and "*" matches any name.
        boolean subscribedOnly = false;
        Mailboxes mailboxes = new Mailboxes();
        try {
            imap.mbxList(subscribedOnly, "", "*", mailboxes);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Loop over each mailbox in the returned collection.
        int n = mailboxes.getCount();
        System.out.println("Number of mailboxes: " + n);

        for (int i = 0; i < n; i++) {
            String name = mailboxes.getName(i);
            System.out.println("Mailbox: " + name);

            // Whether the mailbox can be selected or examined for message access.
            if (mailboxes.isSelectable(i)) {
                System.out.println("  Selectable: yes");
            } else {
                System.out.println("  Selectable: no");
            }

            // Whether the server marked the mailbox as possibly having new messages.
            if (mailboxes.isMarked(i)) {
                System.out.println("  Marked: yes");
            }

            // Whether the mailbox has, or may contain, child mailboxes.
            if (mailboxes.hasInferiors(i)) {
                System.out.println("  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")) {
                System.out.println("  Has child mailboxes");
            }

            // Get all of the mailbox's flags as a comma-separated string.
            String flags = mailboxes.getFlags(i);
            System.out.println("  Flags: " + flags);

            // Iterate the flags individually.
            int numFlags = mailboxes.getNumFlags(i);
            for (int j = 0; j < numFlags; j++) {
                String flag = mailboxes.getNthFlag(i, j);
                System.out.println("    Flag " + j + ": " + flag);
            }
        }

        // Look up a mailbox by name.  Returns -1 if no mailbox with that name is present.
        int sentIndex = mailboxes.getMailboxIndex("Sent");
        if (sentIndex >= 0) {
            System.out.println("The Sent mailbox is at index " + sentIndex);
        }

        try {
            imap.disconnect();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }
    }
}