Visual FoxPro
Visual FoxPro
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
Chilkat Visual FoxPro Downloads
LOCAL lnSuccess
LOCAL loHttp
LOCAL loSbResponse
LOCAL loJson
LOCAL loHtFolderMap
LOCAL loSbMap
LOCAL lcFolderId
LOCAL lnTotalItemCount
LOCAL lnChildFolderCount
lnSuccess = 0
* This example requires the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
loHttp = 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).
loHttp.AuthToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"
loSbResponse = CreateObject('Chilkat.StringBuilder')
* This gets the combined total number of emails in all folders.
lnSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/messages/$count",loSbResponse)
IF ((lnSuccess <> 1) AND (loHttp.LastStatus = 0)) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponse
CANCEL
ENDIF
loJson = CreateObject('Chilkat.JsonObject')
loJson.EmitCompact = 0
* 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
CANCEL
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('Chilkat.Hashtable')
loSbMap = CreateObject('Chilkat.StringBuilder')
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 <> 1) THEN
? "Folder ID not found"
RELEASE loHttp
RELEASE loSbResponse
RELEASE loJson
RELEASE loHtFolderMap
RELEASE loSbMap
CANCEL
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.
lnSuccess = loHttp.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}",loSbResponse)
IF ((lnSuccess <> 1) AND (loHttp.LastStatus = 0)) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponse
RELEASE loJson
RELEASE loHtFolderMap
RELEASE loSbMap
CANCEL
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
CANCEL
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