React Native

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 React Native Downloads

Download Chilkat for React Native

React Native

import { Imap } from '@chilkat/react-native'

async function chilkatExample() {
  // 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.

  const imap = new Imap();

  imap.ssl = true;
  imap.port = 993;

  try {
    await imap.connectAsync('imap.example.com');
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  try {
    await imap.loginAsync('user@example.com', 'myPassword');
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  try {
    await imap.selectMailboxAsync('Inbox');
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  // Enter IDLE mode to monitor the mailbox for changes (new mail, deletions, flag changes).
  try {
    await imap.idleStartAsync();
  } catch {
    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.
  try {
    await imap.idleDoneAsync();
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  try {
    await imap.disconnectAsync();
  } catch {
    console.log(imap.lastErrorText);
    return;
  }
}