Xbase++

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

Xbase++

LOCAL nSuccess
LOCAL oHttp
LOCAL oSbResponse
LOCAL oJson
LOCAL oHtFolderMap
LOCAL oSbMap
LOCAL cFolderId
LOCAL nTotalItemCount
LOCAL nChildFolderCount

nSuccess := 0

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

oHttp := 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).

oHttp:AuthToken := "MICROSOFT_GRAPH_ACCESS_TOKEN"

oSbResponse := CreateObject("Chilkat.StringBuilder")

//  This gets the combined total number of emails in all folders.
nSuccess := oHttp:QuickGetSb("https://graph.microsoft.com/v1.0/me/messages/$count", oSbResponse)
IF ((nSuccess != 1) .AND. (oHttp:LastStatus == 0))
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponse:destroy()
    RETURN
ENDIF

oJson := CreateObject("Chilkat.JsonObject")
oJson:EmitCompact := 0

//  If the status code was not 200, then it failed and the response is likely JSON:
IF (oHttp:LastStatus != 200)
    ? "Status code = " + Str(oHttp:LastStatus)
    oJson:LoadSb(oSbResponse)
    ? oJson:Emit()
    ? "Failed."
    oHttp:destroy()
    oSbResponse:destroy()
    oJson:destroy()
    RETURN
ENDIF

//  A success response payload contains just the integer value (it is not JSON)
? "Combined Total Number of Emails = " + oSbResponse: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)
oHtFolderMap := CreateObject("Chilkat.Hashtable")
oSbMap := CreateObject("Chilkat.StringBuilder")
oSbMap:LoadFile("qa_data/outlook/folderMap.xml", "utf-8")
oHtFolderMap:AddFromXmlSb(oSbMap)

//  Get the ID for the "/Inbox/abc" folder:
cFolderId := oHtFolderMap:LookupStr("/Inbox/abc")
IF (oHtFolderMap:LastMethodSuccess != 1)
    ? "Folder ID not found"
    oHttp:destroy()
    oSbResponse:destroy()
    oJson:destroy()
    oHtFolderMap:destroy()
    oSbMap:destroy()
    RETURN
ENDIF

oHttp:SetUrlVar("folder_id", cFolderId)

//  Send the request get the folder information.
//  In this case we are NOT using the $count system query option.
nSuccess := oHttp:QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}", oSbResponse)
IF ((nSuccess != 1) .AND. (oHttp:LastStatus == 0))
    ? oHttp:LastErrorText
    oHttp:destroy()
    oSbResponse:destroy()
    oJson:destroy()
    oHtFolderMap:destroy()
    oSbMap:destroy()
    RETURN
ENDIF

oJson:LoadSb(oSbResponse)
? oJson:Emit()
? "--"

IF (oHttp:LastStatus != 200)
    ? "Status code = " + Str(oHttp:LastStatus)
    ? "Failed."
    oHttp:destroy()
    oSbResponse:destroy()
    oJson:destroy()
    oHtFolderMap:destroy()
    oSbMap:destroy()
    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:
nTotalItemCount := oJson:IntOf("totalItemCount")
? "totalItemCount = " + Str(nTotalItemCount)

nChildFolderCount := oJson:IntOf("childFolderCount")
? "childFolderCount = " + Str(nChildFolderCount)

//  etc..

oHttp:destroy()
oSbResponse:destroy()
oJson:destroy()
oHtFolderMap:destroy()
oSbMap:destroy()