Sample code for 30+ languages & platforms
Android™

Search IMAP Mailbox for Email Matching Criteria

Searching an IMAP mailbox for messages that match search criteria.

Chilkat Android™ Downloads

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;

    // This example requires 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);
    success = imap.Connect("imap.example.com");
    if (success == false) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    // Login
    success = imap.Login("myLogin","myPassword");
    if (success == false) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

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

    // We can choose to fetch UIDs or sequence numbers.
    boolean fetchUids = true;

    // Here are examples of different search criteria:

    // Return all messages.
    String allMsgs = "ALL";

    // Search for already-answered emails.
    String answered = "ANSWERED";

    // Search for messages on a specific date.
    // The date string is DD-Month-YYYY where Month is
    // Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, or Dec.
    String onDate = "SENTON 05-Mar-2007";

    // Search for messages between two dates.  SENTBEFORE
    // finds emails sent before a date, and SENTSINCE finds
    // email sent on or after a date.  The "AND" operation
    // is implied by joining criteria, separated by spaces.
    String betweenDates = "SENTSINCE 01-Mar-2007 SENTBEFORE 05-Mar-2007";

    // Another example of AND: find all unanswered emails
    // sent after 04-Mar-2007 with "Problem" in the subject:
    String complexSearch1 = "UNANSWERED SENTSINCE 04-Mar-2007 Subject \"Problem\"";

    // Find messages with a specific string in the body:
    String bodySearch = "BODY \"problem solved\"";

    // Using OR.  The syntax is OR <criteria1> <criteria2>. 
    // The "OR" comes first, followed by each criteria.
    // For example, to match all emails with "Help" or "Question" in the subject.
    // You'll notice that literal strings may be quoted or unquoted.
    // If a literal contains SPACE characters, quote it:
    String orSearch = "OR SUBJECT Help SUBJECT Question";

    // ----------------------------------------------
    // Strings are case-insensitive when searching....
    // ----------------------------------------------

    // Find all emails sent from yahoo.com addresses:
    String fromSearch = "FROM yahoo.com";
    // Find all emails sent from anyone with "John" in their name:
    String johnSearch = "FROM John";

    // Find emails with the RECENT flag set:
    String recentSearch = "RECENT";

    // Find emails that don't have the recent flag set:
    String notRecentSearch = "NOT RECENT";
    // This is synonymous with "OLD":
    String oldSearch = "OLD";

    // Find all emails marked for deletion:
    String markedForDeleteSearch = "DELETED";

    // Find all emails having a specified header field with a value
    // containing a substring:
    String headerSearch = "HEADER DomainKey-Signature paypal.com";

    // Find any emails having a specific header field.  If the 
    // 2nd argument to the "HEADER" criteria is an empty string,
    // any email having the header field is returned regardless
    // of the header field's content.
    // Find any emails with a DomainKey-Signature field:
    String headerExistsSearch = "HEADER DomainKey-Signature \"\"";

    // Find NEW emails: these are emails that have the RECENT flag
    // set, but not the SEEN flag:
    String newSearch = "NEW";

    // Find emails larger than a certain number of bytes:
    String sizeLargerSearch = "LARGER 500000";

    // Find emails marked as seen or not already seen:
    String seenSearch = "SEEN";
    String notSeenSearch = "NOT SEEN";

    // Find emails having a given substring in the TO header field:
    String toSearch = "TO support@chilkatsoft.com";
    // A more long-winded way to do the same thing:
    String toSearch2 = "HEADER TO support@chilkatsoft.com";

    // Find emails smaller than a size in bytes:
    String smallerSearch = "SMALLER 30000";

    // Find emails that have a substring anywhere in the header
    // or body:
    String fullSubstringSearch = "TEXT \"Zip Component\"";

    // Pass any of the above strings here to test a search:
    CkMessageSet messageSet = new CkMessageSet();
    success = imap.QueryMbx(orSearch,fetchUids,messageSet);
    if (success == false) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    // Fetch the email headers into a bundle object:
    CkEmailBundle bundle = new CkEmailBundle();
    boolean headersOnly = true;
    success = imap.FetchMsgSet(headersOnly,messageSet,bundle);
    if (success == false) {
        Log.i(TAG, imap.lastErrorText());
        return;
        }

    // Display the Subject and From of each email.
    CkEmail email = new CkEmail();
    int i = 0;
    while (i < bundle.get_MessageCount()) {
        bundle.EmailAt(i,email);

        Log.i(TAG, email.getHeaderField("Date"));
        Log.i(TAG, email.subject());
        Log.i(TAG, email.ck_from());
        Log.i(TAG, "--");

        i = i + 1;
        }

    // Disconnect from the IMAP server.
    success = imap.Disconnect();

  }

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