(Ruby) 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 Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# 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.put_AuthToken("MICROSOFT_GRAPH_ACCESS_TOKEN")

sbResponse = Chilkat::CkStringBuilder.new()

# 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
messageId = "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAA=="
http.SetUrlVar("message_id",messageId)

# Send the request to download the attachments.
success = http.QuickGetSb("https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/messages/{$message_id}/attachments",sbResponse)
if ((success != true) and (http.get_LastStatus() == 0))
    print http.lastErrorText() + "\n";
    exit
end

# The attachment data is contained within the JSON response.
json = Chilkat::CkJsonObject.new()
json.LoadSb(sbResponse)
json.put_EmitCompact(false)

print "Status code = " + http.get_LastStatus().to_s() + "\n";
if (http.get_LastStatus() != 200)
    print json.emit() + "\n";
    print "Failed." + "\n";
end

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

sbSavePath = Chilkat::CkStringBuilder.new()
attachData = Chilkat::CkBinData.new()
lastMod = Chilkat::CkDateTime.new()
fac = Chilkat::CkFileAccess.new()

i = 0
numMessages = json.SizeOfArray("value")
while i < numMessages
    json.put_I(i)

    print "name: " + json.stringOf("value[i].name") + "\n";
    print "contentType: " + json.stringOf("value[i].contentType") + "\n";
    sizeInBytes = json.IntOf("value[i].size")
    print "size: " + sizeInBytes.to_s() + "\n";

    # 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 "----" + "\n";

    i = i + 1
end

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