(Visual FoxPro) Outlook -- List Selected Fields in Messages

Demonstrates how to list the messages in a particular Outlook mailbox folder, but selects particular fields to be returned.

This uses the OData $select system query option. See OData System Query Option $select for general information.

Also see OData URL Conventions for information about $select and other query options.

Note: This example requires Chilkat v9.5.0.68 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

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

* In this example, we'd like to get the messages in the folder "/Inbox",
* 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" folder:
lcFolderId = loHtFolderMap.LookupStr("/Inbox")
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, returning only the subject and from address.
lnSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$select=subject,from",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

? loJson.Emit()

* 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")
    ? "Subject: " + loJson.StringOf("value[i].subject")
    ? "--"

    i = i + 1
ENDDO

* The output of the above loop:
* 
* 	id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1oAAAA=
* 	From Name: Chilkat Software
* 	From Addr: admin@chilkat.io
* 	Subject: This is an example email from chilkat.io
* 	--
* 	id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1kAAAA=
* 	From Name: Chilkat Support
* 	From Addr: chilkat.support@gmail.com
* 	Subject: Hello from GMail
* 	--
* 	id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAHrLra8AAAA=
* 	From Name: Microsoft Office 365
* 	From Addr: MicrosoftOffice365@email.office.com
* 	Subject: The latest for you in Office 365
* 	--
* 	id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_EAAAA=
* 	From Name: Amazon Web Services
* 	From Addr: no-reply-aws@amazon.com
* 	Subject: Amazon SES Address Verification Request in region US West (Oregon)
* 	--
* 	id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_AAAAA=
* 	From Name: Amazon Web Services
* 	From Addr: no-reply-aws@amazon.com
* 	Subject: Amazon SES Address Verification Request in region US West (Oregon)
* 	--
* 	id: AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAAG6l8UAAAA=
* 	From Name: Microsoft
* 	From Addr: msa@communication.microsoft.com
* 	Subject: Updates to our terms of use and privacy statement
* 	--
* 

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

* {
*   "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders('AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA')/messages(subject,from)",
*   "value": [
*     {
*       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpwfo\"",
*       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1oAAAA=",
*       "subject": "This is an example email from chilkat.io",
*       "from": {
*         "emailAddress": {
*           "name": "Chilkat Software",
*           "address": "admin@chilkat.io"
*         }
*       }
*     },
*     {
*       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AADOpwfn\"",
*       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAM6Jj1kAAAA=",
*       "subject": "Hello from GMail",
*       "from": {
*         "emailAddress": {
*           "name": "Chilkat Support",
*           "address": "chilkat.support@gmail.com"
*         }
*       }
*     },
*     {
*       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAB63d8O\"",
*       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAHrLra8AAAA=",
*       "subject": "The latest for you in Office 365",
*       "from": {
*         "emailAddress": {
*           "name": "Microsoft Office 365",
*           "address": "MicrosoftOffice365@email.office.com"
*         }
*       }
*     },
*     {
*       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAA1jyl7\"",
*       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_EAAAA=",
*       "subject": "Amazon SES Address Verification Request in region US West (Oregon)",
*       "from": {
*         "emailAddress": {
*           "name": "Amazon Web Services",
*           "address": "no-reply-aws@amazon.com"
*         }
*       }
*     },
*     {
*       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAA1jyl6\"",
*       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAADLHd_AAAAA=",
*       "subject": "Amazon SES Address Verification Request in region US West (Oregon)",
*       "from": {
*         "emailAddress": {
*           "name": "Amazon Web Services",
*           "address": "no-reply-aws@amazon.com"
*         }
*       }
*     },
*     {
*       "@odata.etag": "W/\"CQAAABYAAADn68XtMop0TpsYJGpfKXY9AAAGt5YG\"",
*       "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgBGAAADsVyfxjDU406Ic4X7ill8xAcA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA5_vF7TKKdE6bGCRqXyl2PQAAAAG6l8UAAAA=",
*       "subject": "Updates to our terms of use and privacy statement",
*       "from": {
*         "emailAddress": {
*           "name": "Microsoft",
*           "address": "msa@communication.microsoft.com"
*         }
*       }
*     }
*   ]
* }

RELEASE loHttp
RELEASE loSbResponse
RELEASE loHtFolderMap
RELEASE loSbMap
RELEASE loJson