(Android™) IMAP Get List of Flags

When a mailbox is selected, the server response includes a list of flags:

The FLAGS response occurs as a result of a SELECT or EXAMINE command. The flag parenthesized list identifies the flags (at a minimum, the system-defined flags) that are applicable for this mailbox. Flags other than the system flags can also exist, depending on server implementation.

Chilkat Android™ Downloads Android™ Java Libraries Android C/C++ Libraries

// 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);

    CkImap imap = new CkImap();

    // This example assumes Chilkat Imap to have been previously unlocked.
    // See Unlock Imap for sample code.

    // 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) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    // Login
    success = imap.Login("MY-IMAP-LOGIN","MY-IMAP-PASSWORD");
    if (success != true) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    // Select an IMAP mailbox
    success = imap.SelectMailbox("INBOX");
    if (success != true) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    // The LastResponse property contains the full response of the last command.
    String selectResponse = imap.lastResponse();
    Log.i(TAG, selectResponse);

    // For example, on GMail, the SELECT response looks like this:

    // 	* FLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk)
    // 	* OK [PERMANENTFLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk \*)] Flags permitted.
    // 	* OK [UIDVALIDITY 3] UIDs valid.
    // 	* 46 EXISTS
    // 	* 0 RECENT
    // 	* OK [UIDNEXT 4147] Predicted next UID.
    // 	* OK [HIGHESTMODSEQ 402971]
    // 	aaac OK [READ-WRITE] INBOX selected. (Success)

    // The goal of this example is to capture the list of FLAGS.
    // All IMAP servers will respond with the list of flags in a SPACE separated list enclosed in parentheses.

    CkStringBuilder sbResponse = new CkStringBuilder();
    sbResponse.Append(selectResponse);

    // Get just the list of flags:
    CkStringBuilder sbFlagList = new CkStringBuilder();
    sbFlagList.Append(sbResponse.getAfterBetween("* FLAGS","(",")"));
    Log.i(TAG, sbFlagList.getAsString());

    // sbFlagList contains this:  
    // 
    //     \Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk
    // 

    // Make sure no more than one SPACE char in a row exists.
    sbFlagList.TrimInsideSpaces();
    // Modify sbFlagList to one flag per line
    int numReplaced = sbFlagList.Replace(" ","\r\n");

    // Load a StringTable with the flag names.
    CkStringTable flagsTable = new CkStringTable();
    flagsTable.AppendFromSb(sbFlagList);

    // Iterate over the individual flag names:
    int i = 0;
    while (i < flagsTable.get_Count()) {
        Log.i(TAG, String.valueOf(i) + ": " + flagsTable.stringAt(i));
        i = i + 1;
        }

    // The output is:
    // 
    // 	0: \Answered
    // 	1: \Flagged
    // 	2: \Draft
    // 	3: \Deleted
    // 	4: \Seen
    // 	5: $Forwarded
    // 	6: $NotPhishing
    // 	7: $Phishing
    // 	8: $label1
    // 	9: $label2
    // 	10: $label3
    // 	11: $label4
    // 	12: $label5
    // 	13: Junk
    // 	14: NonJunk
    // 

  }

  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."
  }
}