AutoIt
AutoIt
Outlook -- List Mail Folders
See more Outlook Examples
Uses the Microsoft Graph API to list Outlook mail folders.Note: This example requires Chilkat v9.5.0.67 or greater.
This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
Chilkat AutoIt Downloads
Local $bSuccess = False
; 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")
; Sends: GET /users/{id | userPrincipalName}/mailFolders
; Note: It is also possible to use the literal string "me" for the current logged-on user.
; For example: GET /me/mailFolders
$oHttp.ClearUrlVars
$oHttp.SetUrlVar("userPrincipalName","chilkatsoft@outlook.com")
$bSuccess = $oHttp.QuickGetSb("https://graph.microsoft.com/v1.0/users/{$userPrincipalName}/mailFolders",$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)
ConsoleWrite("----" & @CRLF)
; In my test case, this is the result (see below)
; Apparently, this lists folders without listing subfolders (aka child folders)
; There's another REST API call to list child folders.
; To iterate over the folders:
Local $i = 0
Local $iNumFolders = $oJson.SizeOfArray("value")
While $i < $iNumFolders
$oJson.I = $i
ConsoleWrite($oJson.StringOf("value[i].displayName") & @CRLF)
$i = $i + 1
Wend
; The output from the above loop:
; Archive
; Deleted Items
; Drafts
; Inbox
; Junk Email
; Outbox
; Sent Items
; ------------------------------------------------------------------------------------
; The raw JSON response:
; {
; "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('chilkatsoft%40outlook.com')/mailFolders",
; "value": [
; {
; "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAG8XunwAAAA=",
; "displayName": "Archive",
; "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
; "childFolderCount": 0,
; "unreadItemCount": 0,
; "totalItemCount": 0
; },
; {
; "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEKAAAA",
; "displayName": "Deleted Items",
; "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
; "childFolderCount": 0,
; "unreadItemCount": 0,
; "totalItemCount": 0
; },
; {
; "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEPAAAA",
; "displayName": "Drafts",
; "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
; "childFolderCount": 0,
; "unreadItemCount": 0,
; "totalItemCount": 0
; },
; {
; "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA",
; "displayName": "Inbox",
; "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
; "childFolderCount": 2,
; "unreadItemCount": 0,
; "totalItemCount": 4
; },
; {
; "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEiAAAA",
; "displayName": "Junk Email",
; "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
; "childFolderCount": 0,
; "unreadItemCount": 0,
; "totalItemCount": 0
; },
; {
; "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgELAAAA",
; "displayName": "Outbox",
; "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
; "childFolderCount": 0,
; "unreadItemCount": 0,
; "totalItemCount": 0
; },
; {
; "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEJAAAA",
; "displayName": "Sent Items",
; "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEIAAAA",
; "childFolderCount": 0,
; "unreadItemCount": 0,
; "totalItemCount": 14
; }
; ]
; }
;
; ------------------------------------------------------------------------------------------------------
; This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com
;
; The Microsoft Graph Outlook Mail API lets you read, create, and send messages and attachments,
; view and respond to event messages, and manage folders that are secured by Azure Active Directory
; in Office 365. It also provides the same functionality in Microsoft accounts specifically
; in these domains: Hotmail.com, Live.com, MSN.com, Outlook.com, and Passport.com.