Java

Start IMAP IDLE to Monitor a Mailbox

Demonstrates the Chilkat Imap.IdleStart method, which sends the IMAP IDLE command to begin listening for unsolicited mailbox updates. It takes no arguments. A mailbox must first be selected, and the server must advertise the IDLE capability.

Background: IDLE is IMAP's push mechanism: instead of polling for new mail, the client tells the server "notify me when something changes," and the server pushes updates as they happen. This is what enables near-instant new-mail alerts. While IDLE is active, no other IMAP command may be sent on that connection — call IdleDone to leave IDLE before issuing other commands.

Chilkat Java Downloads

Download Chilkat for Java

Java

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[])
  {
    boolean success = false;

    //  Demonstrates the Imap.IdleStart method, which sends the IMAP IDLE command to begin listening
    //  for unsolicited mailbox updates.  It takes no arguments.  A mailbox must be selected and the
    //  server must advertise the IDLE capability.

    CkImap imap = new CkImap();

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

    success = imap.Connect("imap.example.com");
    if (success == false) {
        System.out.println(imap.lastErrorText());
        return;
        }

    success = imap.Login("user@example.com","myPassword");
    if (success == false) {
        System.out.println(imap.lastErrorText());
        return;
        }

    success = imap.SelectMailbox("Inbox");
    if (success == false) {
        System.out.println(imap.lastErrorText());
        return;
        }

    //  Enter IDLE mode to monitor the mailbox for changes (new mail, deletions, flag changes).
    success = imap.IdleStart();
    if (success == false) {
        System.out.println(imap.lastErrorText());
        return;
        }

    System.out.println("IDLE mode started.");

    //  While IDLE is active, no other IMAP command may be sent.  End IDLE before doing more work.
    success = imap.IdleDone();
    if (success == false) {
        System.out.println(imap.lastErrorText());
        return;
        }

    success = imap.Disconnect();
    if (success == false) {
        System.out.println(imap.lastErrorText());
        return;
        }
  }
}