Dart

List and Inspect IMAP Mailboxes

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.

Background: Mailboxes is how an application renders an IMAP folder tree. Because it is read-only, you never construct it directly — you receive it from MbxList and read its entries by index. Mailbox names come back as normal Unicode text (Chilkat handles the modified UTF-7 / IMAP UTF-8 encoding at the protocol level), so a name from GetName can be passed straight to methods like SelectMailbox. Note that HasInferiors is often true: it means children exist or may be created, which is not the same as \HasChildren.

Chilkat Dart Downloads

Download Chilkat for Dart

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // 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.

  final imap = CkImap();

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

  try {
    imap.connect('imap.example.com');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  try {
    imap.login('user@example.com', 'myPassword');
  } on ChilkatException catch (e) {
    print(e.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.
  final subscribedOnly = false;
  final mailboxes = CkMailboxes();
  try {
    imap.mbxList(subscribedOnly, '', '*', mailboxes);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Loop over each mailbox in the returned collection.
  final n = mailboxes.count;
  print('Number of mailboxes: $n');

  for (var i = 0; i < n; i++) {
    final name = mailboxes.getName(i);
    print('Mailbox: $name');

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

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

    // Whether the mailbox has, or may contain, child mailboxes.
    if (mailboxes.hasInferiors(i)) {
      print('  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')) {
      print('  Has child mailboxes');
    }

    // Get all of the mailbox's flags as a comma-separated string.
    final flags = mailboxes.getFlags(i);
    print('  Flags: $flags');

    // Iterate the flags individually.
    final numFlags = mailboxes.getNumFlags(i);
    for (var j = 0; j < numFlags; j++) {
      final flag = mailboxes.getNthFlag(i, j);
      print('    Flag $j: $flag');
    }
  }

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

  try {
    imap.disconnect();
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }
}