Lianja

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

Lianja

llSuccess = .F.

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

loHttp = createobject("CkHttp")

// 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).

loHttp.AuthToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"

loSbResponse = createobject("CkStringBuilder")

// This gets the combined total number of emails in all folders.
llSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/messages/$count",loSbResponse)
if ((llSuccess <> .T.) and (loHttp.LastStatus = 0)) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponse
    return
endif

loJson = createobject("CkJsonObject")
loJson.EmitCompact = .F.

// If the status code was not 200, then it failed and the response is likely JSON:
if (loHttp.LastStatus <> 200) then
    ? "Status code = " + str(loHttp.LastStatus)
    loJson.LoadSb(loSbResponse)
    ? loJson.Emit()
    ? "Failed."
    release loHttp
    release loSbResponse
    release loJson
    return
endif

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

// ---------------------------------------------------------------------------
// 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)
loHtFolderMap = createobject("CkHashtable")
loSbMap = createobject("CkStringBuilder")
loSbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
loHtFolderMap.AddFromXmlSb(loSbMap)

// Get the ID for the "/Inbox/abc" folder:
lcFolderId = loHtFolderMap.LookupStr("/Inbox/abc")
if (loHtFolderMap.LastMethodSuccess <> .T.) then
    ? "Folder ID not found"
    release loHttp
    release loSbResponse
    release loJson
    release loHtFolderMap
    release loSbMap
    return
endif

loHttp.SetUrlVar("folder_id",lcFolderId)

// Send the request get the folder information.
// In this case we are NOT using the $count system query option.
llSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}",loSbResponse)
if ((llSuccess <> .T.) and (loHttp.LastStatus = 0)) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponse
    release loJson
    release loHtFolderMap
    release loSbMap
    return
endif

loJson.LoadSb(loSbResponse)
? loJson.Emit()
? "--"

if (loHttp.LastStatus <> 200) then
    ? "Status code = " + str(loHttp.LastStatus)
    ? "Failed."
    release loHttp
    release loSbResponse
    release loJson
    release loHtFolderMap
    release loSbMap
    return
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:
lnTotalItemCount = loJson.IntOf("totalItemCount")
? "totalItemCount = " + str(lnTotalItemCount)

lnChildFolderCount = loJson.IntOf("childFolderCount")
? "childFolderCount = " + str(lnChildFolderCount)

// etc..


release loHttp
release loSbResponse
release loJson
release loHtFolderMap
release loSbMap