React Native

Get IMAP Mailbox Status

Demonstrates the Chilkat Imap.GetMailboxStatus method, which sends the IMAP STATUS command for a mailbox and returns the reported values as XML attributes — including messages (total count), recent, uidnext, uidvalidity, and unseen. This example gets the Inbox status.

Tip: XML parsing code for this result can be generated at Chilkat Tools.

Background: STATUS queries a mailbox's summary counts without selecting it — ideal for showing unread counts across many folders in a UI, or checking whether a folder has new mail before deciding to open it. Two values are especially useful for sync: uidvalidity (if it changes, previously stored UIDs are no longer valid) and uidnext (the UID the next new message will get, so anything at or above a remembered value is new).

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

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

async function chilkatExample() {
  // Demonstrates the Imap.GetMailboxStatus method, which sends the IMAP STATUS command for a
  // mailbox and returns the reported values as XML attributes (such as messages, recent,
  // uidnext, uidvalidity, and unseen).

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

  // Get the status of a mailbox (without selecting it).
  let statusXml: string;
  try {
    statusXml = await imap.getMailboxStatusAsync('Inbox');
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  console.log(statusXml);

  // XML parsing code for this result can be generated at Chilkat's online tool:
  // https://tools.chilkat.io/xmlParse

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