(Java) List IMAP Mailboxes

List the mailboxes available within an IMAP account.

Chilkat Java Downloads Java Libs for Windows, MacOS, Linux, Alpine Linux, Solaris Java Libs for Android

import com.chilkatsoft.*;

public class ChilkatExample {

  static {
    try {
        System.loadLibrary("chilkat");
    } catch (UnsatisfiedLinkError e) {
      System.err.println("Native code library failed to load.\n" + e);
      System.exit(1);
    }
  }

  public static void main(String argv[])
  {
    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    CkImap imap = new CkImap();

    // Connect to an IMAP server.
    // Use TLS
    imap.put_Ssl(true);
    imap.put_Port(993);
    boolean success = imap.Connect("MY-IMAP-DOMAIN");
    if (success != true) {
        System.out.println(imap.lastErrorText());
        return;
        }

    // Login
    success = imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD");
    if (success != true) {
        System.out.println(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.

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

    CkMailboxes mboxes = imap.ListMailboxes(refName,wildcardedMailbox);
    if (imap.get_LastMethodSuccess() == false) {
        System.out.println(imap.lastErrorText());
        return;
        }

    int i = 0;
    while (i < mboxes.get_Count()) {
        System.out.println(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();
  }
}