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

Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Imap;

public class ChilkatExample {

    public static void main(String[] args) {
        // 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.

        Imap imap = new Imap();

        imap.setSsl(true);
        imap.setPort(993);

        try {
            imap.connect("imap.example.com");

            imap.login("user@example.com", "myPassword");

            imap.selectMailbox("Inbox");

            // Enter IDLE mode to monitor the mailbox for changes (new mail, deletions, flag changes).
            imap.idleStart();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

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

        // While IDLE is active, no other IMAP command may be sent.  End IDLE before doing more work.
        try {
            imap.idleDone();

            imap.disconnect();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }
    }
}