Android™

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 Android™ Downloads

Download Chilkat for Android™

Android™

// Important: Don't forget to include the call to System.loadLibrary
// as shown at the bottom of this code sample.
package com.test;

import android.app.Activity;
import com.chilkatsoft.*;

import android.widget.TextView;
import android.os.Bundle;

public class SimpleActivity extends Activity {

  private static final String TAG = "Chilkat";

  // Called when the activity is first created.
  @Override
  public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    boolean 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.

    CkImap imap = new CkImap();

    imap.put_Ssl(true);
    imap.put_Port(993);

    success = imap.Connect("imap.example.com");
    if (success == false) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    success = imap.Login("user@example.com","myPassword");
    if (success == false) {
        Log.i(TAG, 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.
    boolean subscribedOnly = false;
    CkMailboxes mailboxes = new CkMailboxes();
    success = imap.MbxList(subscribedOnly,"","*",mailboxes);
    if (success == false) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    //  Loop over each mailbox in the returned collection.
    int n = mailboxes.get_Count();
    Log.i(TAG, "Number of mailboxes: " + String.valueOf(n));

    int i;
    for (i = 0; i <= n - 1; i++) {
        String name = mailboxes.getName(i);
        Log.i(TAG, "Mailbox: " + name);

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

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

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

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

        //  Iterate the flags individually.
        int numFlags = mailboxes.GetNumFlags(i);
        int j;
        for (j = 0; j <= numFlags - 1; j++) {
            String flag = mailboxes.getNthFlag(i,j);
            Log.i(TAG, "    Flag " + String.valueOf(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) {
        Log.i(TAG, "The Sent mailbox is at index " + String.valueOf(sentIndex));
        }

    success = imap.Disconnect();
    if (success == false) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }


  }

  static {
      System.loadLibrary("chilkat");

      // Note: If the incorrect library name is passed to System.loadLibrary,
      // then you will see the following error message at application startup:
      //"The application <your-application-name> has stopped unexpectedly. Please try again."
  }
}