Dart Requires Chilkat v11.0.0+

Subscribe to Mailboxes and List Subscribed Mailboxes

See more IMAP Examples

Demonstrates how to list subscribed mailboxes, and unsubscribe/subscribe to a mailbox. 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('imap.example.com');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Login
  try {
    imap.login('myLogin', 'myPassword');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // First examine the already subscribed mailboxes.
  final refName = '';
  final wildcardedMailbox = '*';
  final subscribed = true;

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

  print('----');

  // Sample output.

  // INBOX
  // INBOX/recent
  // INBOX/misc
  // INBOX/misc/solutions
  // ...
  // Outbox
  // Deleted Items
  // Sent Items
  // Drafts
  // Junk E-mail
  // Trash
  // Sent
  // Templates

  // Let's unsubscribe to "INBOX/misc/solutions".
  try {
    imap.unsubscribe('INBOX/misc/solutions');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is missing.
  try {
    imap.mbxList(subscribed, '', 'INBOX/misc*', mboxes);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

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

  print('----');

  // Re-subscribe to "INBOX/misc/solutions".
  try {
    imap.subscribe('INBOX/misc/solutions');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Get the list of subscribed mailboxes again to verify that "INBOX/misc/solutions" is back in the list.
  try {
    imap.mbxList(subscribed, '', 'INBOX/misc*', mboxes);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

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

  print('----');

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