Dart Requires Chilkat v11.0.0+

List IMAP Mailboxes

List the mailboxes available within an IMAP account. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // This example assumes the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  final imap = CkImap();

  // Connect to an IMAP server.
  // Use TLS
  imap.ssl = true;
  imap.port = 993;
  try {
    imap.connect('MY-IMAP-DOMAIN');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Login
  try {
    imap.login('MY-IMAP-LOGIN', 'MY-IMAP-PASSWORD');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final refName = '';
  // refName is usually set to an empty string.
  // A non-empty reference name argument is the name of a mailbox or a level of
  // mailbox hierarchy, and indicates the context in which the mailbox
  // name is interpreted.

  // Select all mailboxes matching this pattern:
  final wildcardedMailbox = '*';

  final subscribed = false;

  final mboxes = CkMailboxes();
  try {
    imap.mbxList(subscribed, refName, wildcardedMailbox, mboxes);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  var i = 0;
  while (i < mboxes.count) {
    print(mboxes.getName(i));
    i++;
  }

  // Sample output looks like this:
  // INBOX.vendors.shareit
  // INBOX.oldSupport
  // INBOX.vendors.paypal
  // INBOX.sales
  // INBOX.lists
  // INBOX.Drafts
  // INBOX.vendors.dell
  // INBOX.Trash
  // INBOX.invoiceRequests
  // INBOX.purchases
  // INBOX.vendors.inMotion
  // INBOX.oldEmail
  // INBOX.vendors
  // INBOX.lists.python
  // INBOX.vendors.myhosting
  // INBOX.Templates
  // INBOX.friends
  // INBOX.bounceSamples
  // INBOX.lists.ruby
  // INBOX.vendors.peer1
  // INBOX.Sent
  // INBOX.Junk
  // INBOX

  // Disconnect from the IMAP server.
  imap.disconnect();
}