Dart

Outlook --Download Attachments for a Specific Message

See more Outlook Examples

Demonstrates how to download the attachments for a particular email message.

Note: This example requires Chilkat v9.5.0.67 or greater.

This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  var success = false;

  // This example requires the Chilkat API to have been previously unlocked.
  // See Global Unlock Sample for sample code.

  final http = CkHttp();

  // Use your previously obtained access token here:
  // See the following examples for getting an access token:
  //    Get Microsoft Graph OAuth2 Access Token (Azure AD v2.0 Endpoint).
  //    Get Microsoft Graph OAuth2 Access Token (Azure AD Endpoint).
  //    Refresh Access Token (Azure AD v2.0 Endpoint).
  //    Refresh Access Token (Azure AD Endpoint).

  http.authToken = 'MICROSOFT_GRAPH_ACCESS_TOKEN';

  final sbResponse = CkStringBuilder();

  // Sends:  GET /users/{user_id | userPrincipalName}/messages/{message_id}/attachments
  // Note: It is also possible to use the literal string "me" for the current logged-on user.
  // For example: GET /me/messages/{message_id}/attachments

  http.clearUrlVars();
  http.setUrlVar('userPrincipalName', 'chilkatsoft@outlook.com');

  // Assume we already have a message ID from previously listing the messages in a folder
  final messageId = 'AAMkADYzZWE3YmZmLWU0YzgtNGNkZC04MGE1LWFiYTFlNTRlY2QwYQBGAAAAAAAu7cUXL5YOTrdsUIw7-v8FBwBUcG0qWqkmQYqWLHQataQxAACnwqJUAABUcG0qWqkmQYqWLHQataQxAACnwrnOAAA=';
  http.setUrlVar('message_id', messageId);

  // Send the request to download the attachments.
  success = true;
  try {
    http.quickGetSb('https://graph.microsoft.com/v1.0/users/{\$userPrincipalName}/messages/{\$message_id}/attachments', sbResponse);
  } on ChilkatException {
    success = false;
  }
  if ((!success) && (http.lastStatus == 0)) {
    print(http.lastErrorText);
    return;
  }

  // The attachment data is contained within the JSON response.
  final json = CkJsonObject();
  json.loadSb(sbResponse);
  json.emitCompact = false;

  print('Status code = ${http.lastStatus}');
  if (http.lastStatus != 200) {
    print(json.emit());
    print('Failed.');
  }

  // This is a sample JSON response.  The code for parsing and extracting/saving the attachments
  // is shown below.

  // 	{
  // 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('chilkatsoft%40outlook.com')/messages('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAA%3D%3D')/attachments",
  // 	  "value": [
  // 	    {
  // 	      "@odata.type": "#microsoft.graph.fileAttachment",
  // 	      "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAAESABAAft6wtbaSJU6sgQLi98DI0Q==",
  // 	      "lastModifiedDateTime": "2017-05-10T00:30:51Z",
  // 	      "name": "fishing.pdf",
  // 	      "contentType": "application/pdf",
  // 	      "size": 295680,
  // 	      "isInline": false,
  // 	      "contentId": "F861B218BE380F44B16933097FDDACFC@namprd20.prod.outlook.com",
  // 	      "contentLocation": null,
  // 	      "contentBytes": "JVBERi0xLjMKJcfsj6 ... yZWYKMjk0MzY5CiUlRU9GCg=="
  // 	    },
  // 	    {
  // 	      "@odata.type": "#microsoft.graph.fileAttachment",
  // 	      "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAAESABAAXS7qXQ-iRUCYXnhJpN8Ihg==",
  // 	      "lastModifiedDateTime": "2017-05-10T00:30:51Z",
  // 	      "name": "testCert.cer",
  // 	      "contentType": "application/octet-stream",
  // 	      "size": 1674,
  // 	      "isInline": false,
  // 	      "contentId": "5E51FA33EF0F8941ACC8260395CB1A33@namprd20.prod.outlook.com",
  // 	      "contentLocation": null,
  // 	      "contentBytes": "MIIFRjCCBC6gAwIBA ... 7pt3C5w=="
  // 	    }
  // 	  ]
  // 	}

  final sbSavePath = CkStringBuilder();
  final attachData = CkBinData();
  final lastMod = CkDateTime();
  final fac = CkFileAccess();

  var i = 0;
  final numMessages = json.sizeOfArray('value');
  while (i < numMessages) {
    json.i = i;

    print('name: ${json.stringOf('value[i].name')}');
    print('contentType: ${json.stringOf('value[i].contentType')}');
    final sizeInBytes = json.intOf('value[i].size');
    print('size: $sizeInBytes');

    // Extract the data and save to a file.
    sbSavePath.setString('qa_output/');
    sbSavePath.append(json.stringOf('value[i].name'));

    attachData.clear();
    attachData.appendEncoded(json.stringOf('value[i].contentBytes'), 'base64');
    attachData.writeFile(sbSavePath.getAsString());

    // Get the last-modified date/time and set the output file's last-mod date/time..
    lastMod.setFromTimestamp(json.stringOf('value[i].lastModifiedDateTime'));
    fac.setLastModified(sbSavePath.getAsString(), lastMod);

    print('----');

    i++;
  }

  // The output of the above loop is:
  // 
  // 	name: fishing.pdf
  // 	contentType: application/pdf
  // 	size: 295680
  // 	----
  // 	name: testCert.cer
  // 	contentType: application/octet-stream
  // 	size: 1674
  // 	----
  // 
}