Xojo Plugin

Outlook --Download MIME Embedded Images in an HTML Email

See more Outlook Examples

Demonstrates how to download the MIME embedded images for a particular HTML email message.

The code for downloading the embedded HTML images is the same as for downloading attachments. When an HTML email has embedded images (and no real attachments), the JSON returned when listing the message will indicate "hasAttachments": false. However, you can still use the URL for getting attachments to get the embedded images.

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

Xojo Plugin

Dim success As Boolean
success = False

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

Dim http As New Chilkat.Http

// 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"

Dim sbResponse As New Chilkat.StringBuilder

// 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 
success = http.SetUrlVar("userPrincipalName","chilkatsoft@outlook.com")

// Assume we already have a message ID from previously listing the messages in a folder
Dim messageId As String
messageId = "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAA=="
success = http.SetUrlVar("message_id",messageId)

// Send the request to download the attachments.  However, this will also download the embedded images. (Who knew???)
success = http.QuickGetSb("https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/messages/{$message_id}/attachments",sbResponse)
If ((success <> True) And (http.LastStatus = 0)) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

// The attachment data is contained within the JSON response.
Dim json As New Chilkat.JsonObject
success = json.LoadSb(sbResponse)
json.EmitCompact = False

System.DebugLog("Status code = " + Str(http.LastStatus))
If (http.LastStatus <> 200) Then
    System.DebugLog(json.Emit())
    System.DebugLog("Failed.")
End If

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

// {
//   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('chilkatsoft%40outlook.com')/messages('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAA%3D%3D')/attachments",
//   "value": [
//     {
//       "@odata.type": "#microsoft.graph.fileAttachment",
//       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAAESABAAgZG0LQdbKEy5FudPGeyRCg==",
//       "lastModifiedDateTime": "2017-05-10T00:22:45Z",
//       "name": "starfish.jpg",
//       "contentType": "image/jpeg",
//       "size": 6497,
//       "isInline": true,
//       "contentId": "part1.A9EACD6E.4E93E87E@chilkatsoft.com",
//       "contentLocation": null,
//       "contentBytes": "/9j/4AAQSkZJRgABAgEASABIAAD/7Q18UGh ... +vo//2Q=="
//     },
//     {
//       "@odata.type": "#microsoft.graph.fileAttachment",
//       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAAESABAABRgWReFlhEmqGvKeoT0E6g==",
//       "lastModifiedDateTime": "2017-05-10T00:22:45Z",
//       "name": "hedgehogs.jpg",
//       "contentType": "image/jpeg",
//       "size": 48845,
//       "isInline": true,
//       "contentId": "part2.05D9E5DC.BA8874F4@chilkatsoft.com",
//       "contentLocation": null,
//       "contentBytes": "/9j/4AAQSkZJRg ... 9YEa//AMr/AP/Z"
//     }
//   ]
// }

Dim sbSavePath As New Chilkat.StringBuilder
Dim attachData As New Chilkat.BinData
Dim lastMod As New Chilkat.CkDateTime
Dim fac As New Chilkat.FileAccess

Dim i As Int32
i = 0
Dim numMessages As Int32
numMessages = json.SizeOfArray("value")
While i < numMessages
    json.I = i

    System.DebugLog("name: " + json.StringOf("value[i].name"))
    // See the note below about the contentId.
    System.DebugLog("contentId: " + json.StringOf("value[i].contentId"))
    System.DebugLog("contentType: " + json.StringOf("value[i].contentType"))
    Dim sizeInBytes As Int32
    sizeInBytes = json.IntOf("value[i].size")
    System.DebugLog("size: " + Str(sizeInBytes))

    // Extract the data and save to a file.
    success = sbSavePath.SetString("qa_output/")
    success = sbSavePath.Append(json.StringOf("value[i].name"))

    success = attachData.Clear()
    success = attachData.AppendEncoded(json.StringOf("value[i].contentBytes"),"base64")
    success = attachData.WriteFile(sbSavePath.GetAsString())

    // Get the last-modified date/time and set the output file's last-mod date/time..
    success = lastMod.SetFromTimestamp(json.StringOf("value[i].lastModifiedDateTime"))
    success = fac.SetLastModified(sbSavePath.GetAsString(),lastMod)

    System.DebugLog("----")

    i = i + 1
Wend

// The output of the above loop is:

// 	name: starfish.jpg
// 	contentId: part1.A9EACD6E.4E93E87E@chilkatsoft.com
// 	contentType: image/jpeg
// 	size: 6497
// 	----
// 	name: hedgehogs.jpg
// 	contentId: part2.05D9E5DC.BA8874F4@chilkatsoft.com
// 	contentType: image/jpeg
// 	size: 48845
// 	----

// ----------------------------
// NOTE: About the Content-ID
// ----------------------------

// Each image's contentId will correspond to a "cid" in the HTML body of the email.
// For example, in this case, the HTML email contained this:

// 	<html>
// 	<head>
// 	<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
// 	<meta content="text/html; charset=utf-8">
// 	</head>
// 	<body bgcolor="#FFFFFF">
// 	<font face="Calibri">This is a test email with images.<br>
// 	<br>
// 	<img alt="" src="cid:part1.A9EACD6E.4E93E87E@chilkatsoft.com" height="120" width="120"><br>
// 	<img alt="" src="cid:part2.05D9E5DC.BA8874F4@chilkatsoft.com" height="427" width="600"><br>
// 	</font>
// 	</body>
// 	</html>
//