(PureBasic) 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.

Chilkat PureBasic Module Download

Chilkat PureBasic Module

IncludeFile "CkJsonObject.pb"
IncludeFile "CkDateTime.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkFileAccess.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkBinData.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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::setCkAuthToken(http, "MICROSOFT_GRAPH_ACCESS_TOKEN")

    sbResponse.i = CkStringBuilder::ckCreate()
    If sbResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; 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::ckClearUrlVars(http)
    CkHttp::ckSetUrlVar(http,"userPrincipalName","chilkatsoft@outlook.com")

    ; Assume we already have a message ID from previously listing the messages in a folder
    messageId.s = "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAA=="
    CkHttp::ckSetUrlVar(http,"message_id",messageId)

    ; Send the request to download the attachments.
    success.i = CkHttp::ckQuickGetSb(http,"https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/messages/{$message_id}/attachments",sbResponse)
    If (success <> 1) AND (CkHttp::ckLastStatus(http) = 0)
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponse)
        ProcedureReturn
    EndIf

    ; The attachment data is contained within the JSON response.
    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(json,sbResponse)
    CkJsonObject::setCkEmitCompact(json, 0)

    Debug "Status code = " + Str(CkHttp::ckLastStatus(http))
    If CkHttp::ckLastStatus(http) <> 200
        Debug CkJsonObject::ckEmit(json)
        Debug "Failed."
    EndIf

    ; 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.i = CkStringBuilder::ckCreate()
    If sbSavePath.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    attachData.i = CkBinData::ckCreate()
    If attachData.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    lastMod.i = CkDateTime::ckCreate()
    If lastMod.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    fac.i = CkFileAccess::ckCreate()
    If fac.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    i.i = 0
    numMessages.i = CkJsonObject::ckSizeOfArray(json,"value")
    While i < numMessages
        CkJsonObject::setCkI(json, i)

        Debug "name: " + CkJsonObject::ckStringOf(json,"value[i].name")
        Debug "contentType: " + CkJsonObject::ckStringOf(json,"value[i].contentType")
        sizeInBytes.i = CkJsonObject::ckIntOf(json,"value[i].size")
        Debug "size: " + Str(sizeInBytes)

        ; Extract the data and save to a file.
        CkStringBuilder::ckSetString(sbSavePath,"qa_output/")
        CkStringBuilder::ckAppend(sbSavePath,CkJsonObject::ckStringOf(json,"value[i].name"))

        CkBinData::ckClear(attachData)
        CkBinData::ckAppendEncoded(attachData,CkJsonObject::ckStringOf(json,"value[i].contentBytes"),"base64")
        CkBinData::ckWriteFile(attachData,CkStringBuilder::ckGetAsString(sbSavePath))

        ; Get the last-modified date/time and set the output file's last-mod date/time..
        CkDateTime::ckSetFromTimestamp(lastMod,CkJsonObject::ckStringOf(json,"value[i].lastModifiedDateTime"))
        CkFileAccess::ckSetLastModified(fac,CkStringBuilder::ckGetAsString(sbSavePath),lastMod)

        Debug "----"

        i = i + 1
    Wend

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


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponse)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbSavePath)
    CkBinData::ckDispose(attachData)
    CkDateTime::ckDispose(lastMod)
    CkFileAccess::ckDispose(fac)


    ProcedureReturn
EndProcedure