Dart

Get IMAP Mailbox Status

Demonstrates the Chilkat Imap.GetMailboxStatus method, which sends the IMAP STATUS command for a mailbox and returns the reported values as XML attributes — including messages (total count), recent, uidnext, uidvalidity, and unseen. This example gets the Inbox status.

Tip: XML parsing code for this result can be generated at Chilkat Tools.

Background: STATUS queries a mailbox's summary counts without selecting it — ideal for showing unread counts across many folders in a UI, or checking whether a folder has new mail before deciding to open it. Two values are especially useful for sync: uidvalidity (if it changes, previously stored UIDs are no longer valid) and uidnext (the UID the next new message will get, so anything at or above a remembered value is new).

Chilkat Dart Downloads

Download Chilkat for Dart

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // Demonstrates the Imap.GetMailboxStatus method, which sends the IMAP STATUS command for a
  // mailbox and returns the reported values as XML attributes (such as messages, recent,
  // uidnext, uidvalidity, and unseen).

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

  // Get the status of a mailbox (without selecting it).
  final String statusXml;
  try {
    statusXml = imap.getMailboxStatus('Inbox');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  print(statusXml);

  // XML parsing code for this result can be generated at Chilkat's online tool:
  // https://tools.chilkat.io/xmlParse

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