(DataFlex) Outlook -- List Messages in a Specified Folder

Demonstrates how to list the messages in a particular Outlook mailbox folder.

Note: This example requires Chilkat v9.5.0.67 or greater.

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Variant vSbResponse
    Handle hoSbResponse
    Boolean iSuccess
    Handle hoHtFolderMap
    Variant vSbMap
    Handle hoSbMap
    String sFolderId
    Boolean iSuccess
    Handle hoJson
    Integer i
    Integer iNumMessages
    String sMessageId
    Integer iNumRecipients
    Integer j
    String sBodyContent
    String sTemp1
    Integer iTemp1
    Boolean bTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

    // 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).

    Set ComAuthToken Of hoHttp To "MICROSOFT_GRAPH_ACCESS_TOKEN"

    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponse
    If (Not(IsComObjectCreated(hoSbResponse))) Begin
        Send CreateComObject of hoSbResponse
    End

    // Sends:  GET /users/{user_id | userPrincipalName}/mailFolders/{folder_id}/messages
    // Note: It is also possible to use the literal string "me" for the current logged-on user.
    // For example: GET /me/mailFolders/{folder_id}/messages

    Send ComClearUrlVars To hoHttp
    Get ComSetUrlVar Of hoHttp "userPrincipalName" "chilkatsoft@outlook.com" To iSuccess

    // In this example, we'd like to get the messages in the folder "/Inbox/abc",
    // but we must specify the corresponding folder_id.  The best way to do this is to create
    // a local map of folderPaths-to-folderIds.
    // This example does it:  Create Outlook Folder Map)
    Get Create (RefClass(cComChilkatHashtable)) To hoHtFolderMap
    If (Not(IsComObjectCreated(hoHtFolderMap))) Begin
        Send CreateComObject of hoHtFolderMap
    End
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbMap
    If (Not(IsComObjectCreated(hoSbMap))) Begin
        Send CreateComObject of hoSbMap
    End
    Get ComLoadFile Of hoSbMap "qa_data/outlook/folderMap.xml" "utf-8" To iSuccess
    Get pvComObject of hoSbMap to vSbMap
    Get ComAddFromXmlSb Of hoHtFolderMap vSbMap To iSuccess

    // Get the ID for the "/Inbox/abc" folder:
    Get ComLookupStr Of hoHtFolderMap "/Inbox/abc" To sFolderId
    Get ComLastMethodSuccess Of hoHtFolderMap To bTemp1
    If (bTemp1 <> True) Begin
        Showln "Folder ID not found"
        Procedure_Return
    End

    Get ComSetUrlVar Of hoHttp "folder_id" sFolderId To iSuccess

    // Send the request to list the messages.
    Get pvComObject of hoSbResponse to vSbResponse
    Get ComQuickGetSb Of hoHttp "https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders/{$folder_id}/messages" vSbResponse To iSuccess
    Get ComLastStatus Of hoHttp To iTemp1
    If ((iSuccess <> True) And (iTemp1 = 0)) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get pvComObject of hoSbResponse to vSbResponse
    Get ComLoadSb Of hoJson vSbResponse To iSuccess
    Set ComEmitCompact Of hoJson To False

    Get ComLastStatus Of hoHttp To iTemp1
    Showln "Status code = " iTemp1
    Get ComLastStatus Of hoHttp To iTemp1
    If (iTemp1 <> 200) Begin
        Get ComEmit Of hoJson To sTemp1
        Showln sTemp1
        Showln "Failed."
    End

    // In my test case, the raw JSON returned is shown below.
    // Iterate over the messages to get information about each..

    Move 0 To i
    Get ComSizeOfArray Of hoJson "value" To iNumMessages
    While (i < iNumMessages)
        Set ComI Of hoJson To i

        // This is the id for the email message.
        // For REST API calls that require particular email message id, this is what should be used..
        Get ComStringOf Of hoJson "value[i].id" To sMessageId
        Showln "id: " sMessageId

        Get ComStringOf Of hoJson "value[i].from.emailAddress.name" To sTemp1
        Showln "From Name: " sTemp1
        Get ComStringOf Of hoJson "value[i].from.emailAddress.address" To sTemp1
        Showln "From Addr: " sTemp1

        Get ComSizeOfArray Of hoJson "value[i].toRecipients" To iNumRecipients
        Move 0 To j
        While (j < iNumRecipients)
            Set ComJ Of hoJson To j
            Get ComStringOf Of hoJson "value[i].toRecipients[j].emailAddress.name" To sTemp1
            Showln "To Name: " sTemp1
            Get ComStringOf Of hoJson "value[i].toRecipients[j].emailAddress.address" To sTemp1
            Showln "To Addr: " sTemp1
            Move (j + 1) To j
        Loop

        Get ComStringOf Of hoJson "value[i].subject" To sTemp1
        Showln "Subject: " sTemp1
        Get ComBoolOf Of hoJson "value[i].hasAttachments" To bTemp1
        Showln "Has Attachments:" bTemp1

        Get ComStringOf Of hoJson "value[i].body.contentType" To sTemp1
        Showln "Body Content-Type:" sTemp1
        Get ComStringOf Of hoJson "value[i].body.content" To sBodyContent
        // ...

        Showln "----"

        Move (i + 1) To i
    Loop

    // The output of the above loop:

    // id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAA==
    // From Name: Chilkat Software
    // From Addr: support@chilkatsoft.com
    // To Name: Chilkat Software
    // To Addr: chilkatsoft@outlook.com
    // Subject: email with attachments
    // Has Attachments:True
    // Body Content-Type:html
    // ----
    // id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2gAAAA==
    // From Name: Chilkat Software
    // From Addr: support@chilkatsoft.com
    // To Name: Chilkat Software
    // To Addr: chilkatsoft@outlook.com
    // To Name: admin@chilkat.io
    // To Addr: admin@chilkat.io
    // Subject: Re: Test HTML email with embedded images.
    // Has Attachments:False
    // Body Content-Type:html
    // ----
    // id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAA==
    // From Name: Chilkat Software
    // From Addr: support@chilkatsoft.com
    // To Name: chilkatsoft@outlook.com
    // To Addr: chilkatsoft@outlook.com
    // To Name: admin@chilkat.io
    // To Addr: admin@chilkat.io
    // Subject: Test HTML email with embedded images.
    // Has Attachments:False
    // Body Content-Type:html
    // ----

    // ------------------------------------------------------
    // This is the raw JSON response:

    // {
    //   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('chilkatsoft%40outlook.com')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA%3D')/messages",
    //   "value": [
    //     {
    //       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bb\"",
    //       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAA==",
    //       "createdDateTime": "2017-05-10T00:27:40Z",
    //       "lastModifiedDateTime": "2017-05-10T00:30:51Z",
    //       "changeKey": "CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bb",
    //       "categories": [
    //       ],
    //       "receivedDateTime": "2017-05-10T00:27:41Z",
    //       "sentDateTime": "2017-05-10T00:27:12Z",
    //       "hasAttachments": true,
    //       "internetMessageId": "<9a65d233-0882-d346-f405-202a8b1a3acd@chilkatsoft.com>",
    //       "subject": "email with attachments",
    //       "bodyPreview": "This email has attachments...",
    //       "importance": "normal",
    //       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
    //       "conversationId": "AQQkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAQABQcNI8CG1xKpGjzxJTpoOE=",
    //       "isDeliveryReceiptRequested": null,
    //       "isReadReceiptRequested": false,
    //       "isRead": true,
    //       "isDraft": false,
    //       "webLink": "https://outlook.live.com/owa/?ItemID=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2wAAAA%3D%3D&exvsurl=1&viewmodel=ReadMessageItem",
    //       "inferenceClassification": "focused",
    //       "body": {
    //         "contentType": "html",
    //         "content": "<html>...</html>\r\n"
    //       },
    //       "sender": {
    //         "emailAddress": {
    //           "name": "Chilkat Software",
    //           "address": "support@chilkatsoft.com"
    //         }
    //       },
    //       "from": {
    //         "emailAddress": {
    //           "name": "Chilkat Software",
    //           "address": "support@chilkatsoft.com"
    //         }
    //       },
    //       "toRecipients": [
    //         {
    //           "emailAddress": {
    //             "name": "Chilkat Software",
    //             "address": "chilkatsoft@outlook.com"
    //           }
    //         }
    //       ],
    //       "ccRecipients": [
    //       ],
    //       "bccRecipients": [
    //       ],
    //       "replyTo": [
    //       ]
    //     },
    //     {
    //       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bZ\"",
    //       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2gAAAA==",
    //       "createdDateTime": "2017-05-10T00:25:28Z",
    //       "lastModifiedDateTime": "2017-05-10T00:25:44Z",
    //       "changeKey": "CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bZ",
    //       "categories": [
    //       ],
    //       "receivedDateTime": "2017-05-10T00:25:28Z",
    //       "sentDateTime": "2017-05-10T00:25:10Z",
    //       "hasAttachments": false,
    //       "internetMessageId": "<707ff357-28ea-7ebd-9409-f46d752e871f@chilkatsoft.com>",
    //       "subject": "Re: Test HTML email with embedded images.",
    //       "bodyPreview": "My reply...",
    //       "importance": "normal",
    //       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
    //       "conversationId": "AQQkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAQACYVrc_6yptKn9tuOqBiUMQ=",
    //       "isDeliveryReceiptRequested": null,
    //       "isReadReceiptRequested": false,
    //       "isRead": true,
    //       "isDraft": false,
    //       "webLink": "https://outlook.live.com/owa/?ItemID=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2gAAAA%3D%3D&exvsurl=1&viewmodel=ReadMessageItem",
    //       "inferenceClassification": "focused",
    //       "body": {
    //         "contentType": "html",
    //         "content": "<html>\r\n<head>\r\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\r\n<meta content=\"text/html; charset=utf-8\">\r\n</head>\r\n<body bgcolor=\"#FFFFFF\">...</body>\r\n</html>\r\n"
    //       },
    //       "sender": {
    //         "emailAddress": {
    //           "name": "Chilkat Software",
    // 
    //           "address": "support@chilkatsoft.com"
    //         }
    //       },
    //       "from": {
    //         "emailAddress": {
    //           "name": "Chilkat Software",
    //           "address": "support@chilkatsoft.com"
    //         }
    //       },
    //       "toRecipients": [
    //         {
    //           "emailAddress": {
    //             "name": "Chilkat Software",
    //             "address": "chilkatsoft@outlook.com"
    //           }
    //         },
    //         {
    //           "emailAddress": {
    //             "name": "admin@chilkat.io",
    //             "address": "admin@chilkat.io"
    //           }
    //         }
    //       ],
    //       "ccRecipients": [
    //         {
    //           "emailAddress": {
    //             "name": "Matt Smith",
    //             "address": "chilkat.support@gmail.com"
    //           }
    //         }
    //       ],
    //       "bccRecipients": [
    //       ],
    //       "replyTo": [
    //       ]
    //     },
    //     {
    //       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bY\"",
    //       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAA==",
    //       "createdDateTime": "2017-05-10T00:22:23Z",
    //       "lastModifiedDateTime": "2017-05-10T00:22:45Z",
    //       "changeKey": "CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADBQ0bY",
    //       "categories": [
    //       ],
    //       "receivedDateTime": "2017-05-10T00:22:23Z",
    //       "sentDateTime": "2017-05-10T00:22:03Z",
    //       "hasAttachments": false,
    //       "internetMessageId": "<4da724c6-fa94-5516-81d5-9cdf152eddc5@chilkatsoft.com>",
    //       "subject": "Test HTML email with embedded images.",
    //       "bodyPreview": "This is a test email with images...",
    //       "importance": "normal",
    //       "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
    //       "conversationId": "AQQkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAQACYVrc_6yptKn9tuOqBiUMQ=",
    //       "isDeliveryReceiptRequested": null,
    //       "isReadReceiptRequested": false,
    //       "isRead": true,
    //       "isDraft": false,
    //       "webLink": "https://outlook.live.com/owa/?ItemID=AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5%2BvF7TKKdE6bGCRqXyl2PQAAAL8huv8AAADn68XtMop0TpsYJGpfKXY9AAAAwSju2QAAAA%3D%3D&exvsurl=1&viewmodel=ReadMessageItem",
    //       "inferenceClassification": "focused",
    //       "body": {
    //         "contentType": "html",
    //         "content": "<html>...</html>\r\n"
    //       },
    //       "sender": {
    //         "emailAddress": {
    //           "name": "Chilkat Software",
    //           "address": "support@chilkatsoft.com"
    //         }
    //       },
    //       "from": {
    //         "emailAddress": {
    //           "name": "Chilkat Software",
    //           "address": "support@chilkatsoft.com"
    //         }
    //       },
    //       "toRecipients": [
    //         {
    //           "emailAddress": {
    //             "name": "chilkatsoft@outlook.com",
    //             "address": "chilkatsoft@outlook.com"
    //           }
    //         },
    //         {
    //           "emailAddress": {
    //             "name": "admin@chilkat.io",
    //             "address": "admin@chilkat.io"
    //           }
    //         }
    //       ],
    //       "ccRecipients": [
    //         {
    //           "emailAddress": {
    //             "name": "Matt Smith",
    //             "address": "chilkat.support@gmail.com"
    //           }
    //         }
    //       ],
    //       "bccRecipients": [
    //       ],
    //       "replyTo": [
    //       ]
    //     }
    //   ]
    // 
    // }


End_Procedure