Xojo Plugin

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

Xojo Plugin

Dim success As Boolean
success = False

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

Dim http As New 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"

Dim sbResponse As New 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 <> True) And (http.LastStatus = 0)) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

Dim json As New Chilkat.JsonObject
json.EmitCompact = False

// If the status code was not 200, then it failed and the response is likely JSON:
If (http.LastStatus <> 200) Then
    System.DebugLog("Status code = " + Str(http.LastStatus))
    success = json.LoadSb(sbResponse)
    System.DebugLog(json.Emit())
    System.DebugLog("Failed.")
    Return
End If

// A success response payload contains just the integer value (it is not JSON)
System.DebugLog("Combined Total Number of Emails = " + sbResponse.GetAsString())
System.DebugLog("--")

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

// Get the ID for the "/Inbox/abc" folder:
Dim folderId As String
folderId = htFolderMap.LookupStr("/Inbox/abc")
If (htFolderMap.LastMethodSuccess <> True) Then
    System.DebugLog("Folder ID not found")
    Return
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 <> True) And (http.LastStatus = 0)) Then
    System.DebugLog(http.LastErrorText)
    Return
End If

success = json.LoadSb(sbResponse)
System.DebugLog(json.Emit())
System.DebugLog("--")

If (http.LastStatus <> 200) Then
    System.DebugLog("Status code = " + Str(http.LastStatus))
    System.DebugLog("Failed.")
    Return
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:
Dim totalItemCount As Int32
totalItemCount = json.IntOf("totalItemCount")
System.DebugLog("totalItemCount = " + Str(totalItemCount))

Dim childFolderCount As Int32
childFolderCount = json.IntOf("childFolderCount")
System.DebugLog("childFolderCount = " + Str(childFolderCount))

// etc..