Dart

Subscribe to an IMAP Mailbox

Demonstrates the Chilkat Imap.Subscribe method, which subscribes the authenticated IMAP account to a mailbox. Subscription controls which mailboxes are returned by subscribed-mailbox listings. This example subscribes to a mailbox.

Background: An account can have many mailboxes, but a user often cares about only some of them. IMAP's subscription list is that curated set: mail clients typically show subscribed folders by default and hide the rest. Subscribing does not create or change a mailbox — it only adds it to the "show me this one" list (retrieved with a subscribed-only listing). Unsubscribe removes it from that list.

Chilkat Dart Downloads

Download Chilkat for Dart

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // Demonstrates the Imap.Subscribe method, which subscribes the authenticated IMAP account to
  // a mailbox.  Subscription controls which mailboxes are returned by subscribed-mailbox
  // listings.

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

  // Subscribe to a mailbox.
  try {
    imap.subscribe('Archive2026');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print('Subscribed to the mailbox.');

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