(Visual FoxPro) 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

LOCAL loHttp
LOCAL loSbResponse
LOCAL loHtFolderMap
LOCAL loSbMap
LOCAL lcFolderId
LOCAL lnSuccess
LOCAL loJson
LOCAL i
LOCAL lnNumMessages
LOCAL lcMessageId
LOCAL lnNumRecipients
LOCAL j
LOCAL lcBodyContent

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

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

loHttp.AuthToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponse = CreateObject('Chilkat.StringBuilder')

* 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

loHttp.ClearUrlVars()
loHttp.SetUrlVar("userPrincipalName","chilkatsoft@outlook.com")

* 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)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Hashtable')
loHtFolderMap = CreateObject('Chilkat.Hashtable')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbMap = CreateObject('Chilkat.StringBuilder')
loSbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
loHtFolderMap.AddFromXmlSb(loSbMap)

* Get the ID for the "/Inbox/abc" folder:
lcFolderId = loHtFolderMap.LookupStr("/Inbox/abc")
IF (loHtFolderMap.LastMethodSuccess <> 1) THEN
    ? "Folder ID not found"
    RELEASE loHttp
    RELEASE loSbResponse
    RELEASE loHtFolderMap
    RELEASE loSbMap
    CANCEL
ENDIF

loHttp.SetUrlVar("folder_id",lcFolderId)

* Send the request to list the messages.
lnSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders/{$folder_id}/messages",loSbResponse)
IF ((lnSuccess <> 1) AND (loHttp.LastStatus = 0)) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loSbResponse
    RELEASE loHtFolderMap
    RELEASE loSbMap
    CANCEL
ENDIF

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.LoadSb(loSbResponse)
loJson.EmitCompact = 0

? "Status code = " + STR(loHttp.LastStatus)
IF (loHttp.LastStatus <> 200) THEN
    ? loJson.Emit()
    ? "Failed."
ENDIF

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

i = 0
lnNumMessages = loJson.SizeOfArray("value")
DO WHILE i < lnNumMessages
    loJson.I = 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..
    lcMessageId = loJson.StringOf("value[i].id")
    ? "id: " + lcMessageId

    ? "From Name: " + loJson.StringOf("value[i].from.emailAddress.name")
    ? "From Addr: " + loJson.StringOf("value[i].from.emailAddress.address")

    lnNumRecipients = loJson.SizeOfArray("value[i].toRecipients")
    j = 0
    DO WHILE j < lnNumRecipients
        loJson.J = j
        ? "To Name: " + loJson.StringOf("value[i].toRecipients[j].emailAddress.name")
        ? "To Addr: " + loJson.StringOf("value[i].toRecipients[j].emailAddress.address")
        j = j + 1
    ENDDO

    ? "Subject: " + loJson.StringOf("value[i].subject")
    ? "Has Attachments:" + STR(loJson.BoolOf("value[i].hasAttachments"))

    ? "Body Content-Type:" + loJson.StringOf("value[i].body.contentType")
    lcBodyContent = loJson.StringOf("value[i].body.content")
    * ...

    ? "----"

    i = i + 1
ENDDO

* 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": [
*       ]
*     }
*   ]
* 
* }

RELEASE loHttp
RELEASE loSbResponse
RELEASE loHtFolderMap
RELEASE loSbMap
RELEASE loJson