Dart Requires Chilkat v11.0.0+

Fetch Inbox Email Headers

Downloads the headers of all emails in the Inbox and shows some information about each, such as From, Subject, and whether the email has been seen (already read) or not. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // This example requires 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;
  }

  // Select an IMAP mailbox
  try {
    imap.selectMailbox('Inbox');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Normally, when an email is downloaded, its "Seen" flag is automatically set.
  // We don't want our program to be interfering with the "Seen" flags.
  // To do this, set the PeekMode to true.
  imap.peekMode = true;

  // After selecting the mailbox, the NumMessages property
  // will contain the number of emails in the mailbox.
  // When sequence numbers (not UIDs) are used to reference emails,
  // they range from 1 to N, where N is the number of messages in the mailbox.
  // This example will download the headers by sequence numbers.
  final count = imap.numMessages;

  final bundle = CkEmailBundle();
  try {
    imap.fetchRange(true, 1, count, bundle);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  if (bundle.messageCount == 0) {
    print('No messages in Inbox.');
    return;
  }

  // Loop over the email headers.  
  final emailHeader = CkEmail();
  var i = 0;
  while (i < bundle.messageCount) {

    bundle.emailAt(i, emailHeader);

    print(emailHeader.from);
    print(emailHeader.subject);

    // Get the "Seen" flag.
    // When an email is fetched from the IMAP server, the email flags are stored
    // within the email in the "ckx-imap-flags" header.
    // The call to GetMailFlag is simply getting the information from the email header.
    // (it is not communicating with the IMAP server to get this information, because
    // the information was obtained when downloading the headers)
    final seenFlag = imap.getMailFlag(emailHeader, 'Seen');
    if (seenFlag == 1) {
      print('This email has been read (already seen)');
    } else {
      print('This email has not yet been read (it is not yet seen)');
    }

    // We can also look directly at the "ckx-imap-flags" header:
    print('ckx-imap-flags: ${emailHeader.getHeaderField('ckx-imap-flags')}');

    print('--');

    i++;
  }

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