List and Inspect IMAP Mailboxes

See more IMAP Examples

Demonstrates the Chilkat Mailboxes class, a read-only result collection populated by Imap.MbxList. This example connects to an IMAP server, lists all mailboxes into a Mailboxes object, then loops from 0 to Count - 1 and inspects each mailbox: its name (GetName), whether it is selectable (IsSelectable) or marked (IsMarked), whether it may have child mailboxes (HasInferiors), a specific flag (HasFlag), and all of its flags both as a string (GetFlags) and individually (GetNumFlags with GetNthFlag). Finally it looks up a mailbox by name with GetMailboxIndex.

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

async function chilkatExample() {
  // Demonstrates using Chilkat.Imap to populate a Mailboxes object (via MbxList), then looping
  // over the collection to inspect each mailbox's name and attributes.  Mailboxes is a read-only
  // result collection -- applications inspect the entries but do not add, remove, or modify them.

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

  // Populate a Mailboxes object with the full list of mailboxes.  The first argument requests
  // all mailboxes (not subscribed-only) and "*" matches any name.
  const subscribedOnly = false;
  const mailboxes = new Mailboxes();
  try {
    await imap.mbxListAsync(subscribedOnly, '', '*', mailboxes);
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  // Loop over each mailbox in the returned collection.
  const n = mailboxes.count;
  console.log(`Number of mailboxes: ${n}`);

  for (let i = 0; i < n; i++) {
    const name = mailboxes.getName(i);
    console.log(`Mailbox: ${name}`);

    // Whether the mailbox can be selected or examined for message access.
    if (mailboxes.isSelectable(i)) {
      console.log('  Selectable: yes');
    } else {
      console.log('  Selectable: no');
    }

    // Whether the server marked the mailbox as possibly having new messages.
    if (mailboxes.isMarked(i)) {
      console.log('  Marked: yes');
    }

    // Whether the mailbox has, or may contain, child mailboxes.
    if (mailboxes.hasInferiors(i)) {
      console.log('  May have child mailboxes');
    }

    // Check for a specific flag by name.  Include the leading backslash for a system flag;
    // in CkScript a literal backslash in a string is written as "\\".
    if (mailboxes.hasFlag(i, '\\HasChildren')) {
      console.log('  Has child mailboxes');
    }

    // Get all of the mailbox's flags as a comma-separated string.
    const flags = mailboxes.getFlags(i);
    console.log(`  Flags: ${flags}`);

    // Iterate the flags individually.
    const numFlags = mailboxes.getNumFlags(i);
    for (let j = 0; j < numFlags; j++) {
      const flag = mailboxes.getNthFlag(i, j);
      console.log(`    Flag ${j}: ${flag}`);
    }
  }

  // Look up a mailbox by name.  Returns -1 if no mailbox with that name is present.
  const sentIndex = mailboxes.getMailboxIndex('Sent');
  if (sentIndex >= 0) {
    console.log(`The Sent mailbox is at index ${sentIndex}`);
  }

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