(AutoIt) 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

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

$oHttp = ObjCreate("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).

$oHttp.AuthToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"

$oSbResponse = ObjCreate("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)
$oHtFolderMap = ObjCreate("Chilkat.Hashtable")
$oSbMap = ObjCreate("Chilkat.StringBuilder")
$oSbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
$oHtFolderMap.AddFromXmlSb($oSbMap)

; Get the ID for the "/Inbox" folder:
Local $sFolderId = $oHtFolderMap.LookupStr("/Inbox")
If ($oHtFolderMap.LastMethodSuccess <> True) Then
    ConsoleWrite("Folder ID not found" & @CRLF)
    Exit
EndIf

$oHttp.SetUrlVar("folder_id",$sFolderId)

; Send the request to list the messages, returning only the subject and from address.
Local $bSuccess = $oHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}/messages?$select=subject,from",$oSbResponse)
If (($bSuccess <> True) And ($oHttp.LastStatus = 0)) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.LoadSb($oSbResponse)
$oJson.EmitCompact = False

ConsoleWrite("Status code = " & $oHttp.LastStatus & @CRLF)
If ($oHttp.LastStatus <> 200) Then
    ConsoleWrite($oJson.Emit() & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
EndIf

ConsoleWrite($oJson.Emit() & @CRLF)

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

Local $i = 0
Local $iNumMessages = $oJson.SizeOfArray("value")
While $i < $iNumMessages
    $oJson.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..
Local $sMessageId = $oJson.StringOf("value[i].id")
    ConsoleWrite("id: " & $sMessageId & @CRLF)
    ConsoleWrite("From Name: " & $oJson.StringOf("value[i].from.emailAddress.name") & @CRLF)
    ConsoleWrite("From Addr: " & $oJson.StringOf("value[i].from.emailAddress.address") & @CRLF)
    ConsoleWrite("Subject: " & $oJson.StringOf("value[i].subject") & @CRLF)
    ConsoleWrite("--" & @CRLF)

    $i = $i + 1
Wend

; 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"
;         }
;       }
;     }
;   ]
; }