Dart

Fetch a Text IMAP Attachment as a String

Demonstrates the Chilkat Imap.FetchAttachmentString method, which returns one text attachment decoded to a string. The first argument is the Email, the second is the zero-based attachment index, and the third is the charset used to decode the bytes. This example returns the first attachment as a UTF-8 string.

Background: This is the convenient form when you simply want a small text attachment's content inline as a string. Only use it for attachments known to be text; decoding binary content through a charset can alter or corrupt the bytes. For binary data use FetchAttachmentBd, and for large text a StringBuilder (via FetchAttachmentSb) avoids an extra copy.

Chilkat Dart Downloads

Download Chilkat for Dart

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // Demonstrates the Imap.FetchAttachmentString method, which downloads one text attachment and
  // returns it decoded to a string.  The 1st argument is the Email, the 2nd is the zero-based
  // attachment index, and the 3rd is the charset used to decode the bytes.
  // 
  // The message is fetched headers-only, then the attachment is downloaded on demand.

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

  try {
    imap.selectMailbox('Inbox');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Fetch only the message headers.  Attachment bodies are NOT downloaded, but the ckx-imap-*
  // metadata describing the attachments is present, so the attachment info methods still work.
  final headersOnly = true;
  final useUid = false;
  final seqNum = 1;
  final email = CkEmail();
  try {
    imap.fetchEmail(headersOnly, seqNum, useUid, email);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  final numAttach = imap.getMailNumAttach(email);
  if (numAttach > 0) {
    // FetchAttachmentString returns a string, so assign it to a string variable.
    final String attachText;
    try {
      attachText = imap.fetchAttachmentString(email, 0, 'utf-8');
    } on ChilkatException catch (e) {
      print(e.lastErrorText);
      return;
    }

    print(attachText);
  }

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