AutoIt

Outlook -- Get Number of Emails

See more Outlook Examples

Gets the number of emails in an Outlook folder. This uses the OData $count system query option. See OData System Query Option $count for general information.

This example first gets the combined total number of messages across all folders.

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

This example applies to: Exchange Online | Office 365 | Hotmail.com | Live.com | MSN.com | Outlook.com | Passport.com

AutoIt

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")

; This gets the combined total number of emails in all folders.
$bSuccess = $oHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/messages/$count",$oSbResponse)
If (($bSuccess <> True) And ($oHttp.LastStatus = 0)) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

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

; If the status code was not 200, then it failed and the response is likely JSON:
If ($oHttp.LastStatus <> 200) Then
    ConsoleWrite("Status code = " & $oHttp.LastStatus & @CRLF)
    $oJson.LoadSb($oSbResponse)
    ConsoleWrite($oJson.Emit() & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; A success response payload contains just the integer value (it is not JSON)
ConsoleWrite("Combined Total Number of Emails = " & $oSbResponse.GetAsString() & @CRLF)
ConsoleWrite("--" & @CRLF)

; ---------------------------------------------------------------------------
; To get the number of emails in a particular folder, we need to use the folder id.
; 

; In this example, we'd like to get number of 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.
; We'll use the map created by this example:  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/abc" folder:
Local $sFolderId = $oHtFolderMap.LookupStr("/Inbox/abc")
If ($oHtFolderMap.LastMethodSuccess <> True) Then
    ConsoleWrite("Folder ID not found" & @CRLF)
    Exit
EndIf

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

; Send the request get the folder information.
; In this case we are NOT using the $count system query option.
$bSuccess = $oHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}",$oSbResponse)
If (($bSuccess <> True) And ($oHttp.LastStatus = 0)) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJson.LoadSb($oSbResponse)
ConsoleWrite($oJson.Emit() & @CRLF)
ConsoleWrite("--" & @CRLF)

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

; The successful JSON response looks like this;

; 	{
; 	  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('me')/mailFolders/$entity",
; 	  "id": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAL8huv8AAAA=",
; 	  "displayName": "abc",
; 	  "parentFolderId": "AQMkADAwATM0MDAAMS1iNTcwLWI2NTEtMDACLTAwCgAuAAADsVyfxjDU406Ic4X7ill8xAEA5_vF7TKKdE6bGCRqXyl2PQAAAgEMAAAA",
; 	  "childFolderCount": 2,
; 	  "unreadItemCount": 0,
; 	  "totalItemCount": 3
; 	}
; 

; Get the integer value from the JSON like this:
Local $iTotalItemCount = $oJson.IntOf("totalItemCount")
ConsoleWrite("totalItemCount = " & $iTotalItemCount & @CRLF)

Local $iChildFolderCount = $oJson.IntOf("childFolderCount")
ConsoleWrite("childFolderCount = " & $iChildFolderCount & @CRLF)

; etc..