(Tcl) Outlook --Download MIME Embedded Images in an HTML Email

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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

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

set http [new_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).

CkHttp_put_AuthToken $http "MICROSOFT_GRAPH_ACCESS_TOKEN"

set sbResponse [new_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

CkHttp_ClearUrlVars $http
CkHttp_SetUrlVar $http "userPrincipalName" "chilkatsoft@outlook.com"

# Assume we already have a message ID from previously listing the messages in a folder
set messageId "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAA=="
CkHttp_SetUrlVar $http "message_id" $messageId

# Send the request to download the attachments.  However, this will also download the embedded images. (Who knew???)
set success [CkHttp_QuickGetSb $http "https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/messages/{$message_id}/attachments" $sbResponse]
if {expr [$success != 1]  &&  [[CkHttp_get_LastStatus $http] == 0]} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponse
    exit
}

# The attachment data is contained within the JSON response.
set json [new_CkJsonObject]

CkJsonObject_LoadSb $json $sbResponse
CkJsonObject_put_EmitCompact $json 0

puts "Status code = [CkHttp_get_LastStatus $http]"
if {[CkHttp_get_LastStatus $http] != 200} then {
    puts [CkJsonObject_emit $json]
    puts "Failed."
}

# 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"
#     }
#   ]
# }

set sbSavePath [new_CkStringBuilder]

set attachData [new_CkBinData]

set lastMod [new_CkDateTime]

set fac [new_CkFileAccess]

set i 0
set numMessages [CkJsonObject_SizeOfArray $json "value"]
while {$i < $numMessages} {
    CkJsonObject_put_I $json $i

    puts "name: [CkJsonObject_stringOf $json {value[i].name}]"
    # See the note below about the contentId.
    puts "contentId: [CkJsonObject_stringOf $json {value[i].contentId}]"
    puts "contentType: [CkJsonObject_stringOf $json {value[i].contentType}]"
    set sizeInBytes [CkJsonObject_IntOf $json "value[i].size"]
    puts "size: $sizeInBytes"

    # Extract the data and save to a file.
    CkStringBuilder_SetString $sbSavePath "qa_output/"
    CkStringBuilder_Append $sbSavePath [CkJsonObject_stringOf $json "value[i].name"]

    CkBinData_Clear $attachData
    CkBinData_AppendEncoded $attachData [CkJsonObject_stringOf $json "value[i].contentBytes"] "base64"
    CkBinData_WriteFile $attachData [CkStringBuilder_getAsString $sbSavePath]

    # Get the last-modified date/time and set the output file's last-mod date/time..
    CkDateTime_SetFromTimestamp $lastMod [CkJsonObject_stringOf $json "value[i].lastModifiedDateTime"]
    CkFileAccess_SetLastModified $fac [CkStringBuilder_getAsString $sbSavePath] $lastMod

    puts "----"

    set i [expr $i + 1]
}

# 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>
# 

delete_CkHttp $http
delete_CkStringBuilder $sbResponse
delete_CkJsonObject $json
delete_CkStringBuilder $sbSavePath
delete_CkBinData $attachData
delete_CkDateTime $lastMod
delete_CkFileAccess $fac