(Tcl) 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

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_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAA=="
CkHttp_SetUrlVar $http "message_id" $messageId

# Send the request to download the attachments.
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 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=="
# 	    }
# 	  ]
# 	}

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}]"
    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: fishing.pdf
# 	contentType: application/pdf
# 	size: 295680
# 	----
# 	name: testCert.cer
# 	contentType: application/octet-stream
# 	size: 1674
# 	----
# 

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