JavaScript

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.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

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

var imap = new CkImap();

imap.Ssl = true;
imap.Port = 993;

success = imap.Connect("imap.example.com");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

success = imap.Login("user@example.com","myPassword");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

success = imap.SelectMailbox("Inbox");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

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

console.log("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) {
    console.log(imap.LastErrorText);
    return;
}

success = imap.Disconnect();
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}