Sample code for 30+ languages & platforms
React Native

Check for IMAP IDLE Mailbox Updates

See more IMAP Examples

Demonstrates the Chilkat Imap.IdleCheck method, which waits for mailbox updates after IdleStart has entered IDLE mode. The only argument is a timeout in milliseconds; 0 performs a non-blocking poll of notifications already received. This example waits up to 30 seconds.

Background: IdleCheck consumes the notifications already waiting on the connection rather than sending a new polling command. A typical monitoring loop repeatedly calls IdleCheck with a timeout and reacts when updates arrive. Because servers usually drop an idle connection after about 29 minutes, long-lived monitors periodically call IdleDone and then IdleStart again to refresh it.

Chilkat React Native Downloads

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

async function chilkatExample() {
  // Demonstrates the Imap.IdleCheck method, which waits for IMAP IDLE mailbox updates and returns
  // them.  The only argument is a timeout in milliseconds.  Use 0 for a non-blocking poll.

  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;
  }

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

  // Wait up to 30 seconds for mailbox updates.  IdleCheck returns a string, so assign it to a
  // string variable and check for success.
  const timeoutMs = 30000;
  let updates: string;
  try {
    updates = await imap.idleCheckAsync(timeoutMs);
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  console.log(updates);

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

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