VBScript

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

VBScript

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

success = 0

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

set http = 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).

http.AuthToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"

set sbResponse = CreateObject("Chilkat.StringBuilder")

' This gets the combined total number of emails in all folders.
success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/messages/$count",sbResponse)
If ((success <> 1) And (http.LastStatus = 0)) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

set json = CreateObject("Chilkat.JsonObject")
json.EmitCompact = 0

' If the status code was not 200, then it failed and the response is likely JSON:
If (http.LastStatus <> 200) Then
    outFile.WriteLine("Status code = " & http.LastStatus)
    success = json.LoadSb(sbResponse)
    outFile.WriteLine(json.Emit())
    outFile.WriteLine("Failed.")
    WScript.Quit
End If

' A success response payload contains just the integer value (it is not JSON)
outFile.WriteLine("Combined Total Number of Emails = " & sbResponse.GetAsString())
outFile.WriteLine("--")

' ---------------------------------------------------------------------------
' 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)
set htFolderMap = CreateObject("Chilkat.Hashtable")
set sbMap = CreateObject("Chilkat.StringBuilder")
success = sbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
success = htFolderMap.AddFromXmlSb(sbMap)

' Get the ID for the "/Inbox/abc" folder:
folderId = htFolderMap.LookupStr("/Inbox/abc")
If (htFolderMap.LastMethodSuccess <> 1) Then
    outFile.WriteLine("Folder ID not found")
    WScript.Quit
End If

success = http.SetUrlVar("folder_id",folderId)

' Send the request get the folder information.
' In this case we are NOT using the $count system query option.
success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}",sbResponse)
If ((success <> 1) And (http.LastStatus = 0)) Then
    outFile.WriteLine(http.LastErrorText)
    WScript.Quit
End If

success = json.LoadSb(sbResponse)
outFile.WriteLine(json.Emit())
outFile.WriteLine("--")

If (http.LastStatus <> 200) Then
    outFile.WriteLine("Status code = " & http.LastStatus)
    outFile.WriteLine("Failed.")
    WScript.Quit
End If

' 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:
totalItemCount = json.IntOf("totalItemCount")
outFile.WriteLine("totalItemCount = " & totalItemCount)

childFolderCount = json.IntOf("childFolderCount")
outFile.WriteLine("childFolderCount = " & childFolderCount)

' etc..

outFile.Close