PowerBuilder

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

PowerBuilder

integer li_rc
integer li_Success
oleobject loo_Http
oleobject loo_SbResponse
oleobject loo_Json
oleobject loo_HtFolderMap
oleobject loo_SbMap
string ls_FolderId
integer li_TotalItemCount
integer li_ChildFolderCount

li_Success = 0

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

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

loo_Http.AuthToken = "MICROSOFT_GRAPH_ACCESS_TOKEN"

loo_SbResponse = create oleobject
li_rc = loo_SbResponse.ConnectToNewObject("Chilkat.StringBuilder")

// This gets the combined total number of emails in all folders.
li_Success = loo_Http.QuickGetSb("https://graph.microsoft.com/v1.0/me/messages/$count",loo_SbResponse)
if (li_Success <> 1) AND (loo_Http.LastStatus = 0) then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponse
    return
end if

loo_Json = create oleobject
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")

loo_Json.EmitCompact = 0

// If the status code was not 200, then it failed and the response is likely JSON:
if loo_Http.LastStatus <> 200 then
    Write-Debug "Status code = " + string(loo_Http.LastStatus)
    loo_Json.LoadSb(loo_SbResponse)
    Write-Debug loo_Json.Emit()
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponse
    destroy loo_Json
    return
end if

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

// ---------------------------------------------------------------------------
// 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)
loo_HtFolderMap = create oleobject
li_rc = loo_HtFolderMap.ConnectToNewObject("Chilkat.Hashtable")

loo_SbMap = create oleobject
li_rc = loo_SbMap.ConnectToNewObject("Chilkat.StringBuilder")

loo_SbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
loo_HtFolderMap.AddFromXmlSb(loo_SbMap)

// Get the ID for the "/Inbox/abc" folder:
ls_FolderId = loo_HtFolderMap.LookupStr("/Inbox/abc")
if loo_HtFolderMap.LastMethodSuccess <> 1 then
    Write-Debug "Folder ID not found"
    destroy loo_Http
    destroy loo_SbResponse
    destroy loo_Json
    destroy loo_HtFolderMap
    destroy loo_SbMap
    return
end if

loo_Http.SetUrlVar("folder_id",ls_FolderId)

// Send the request get the folder information.
// In this case we are NOT using the $count system query option.
li_Success = loo_Http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}",loo_SbResponse)
if (li_Success <> 1) AND (loo_Http.LastStatus = 0) then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_SbResponse
    destroy loo_Json
    destroy loo_HtFolderMap
    destroy loo_SbMap
    return
end if

loo_Json.LoadSb(loo_SbResponse)
Write-Debug loo_Json.Emit()
Write-Debug "--"

if loo_Http.LastStatus <> 200 then
    Write-Debug "Status code = " + string(loo_Http.LastStatus)
    Write-Debug "Failed."
    destroy loo_Http
    destroy loo_SbResponse
    destroy loo_Json
    destroy loo_HtFolderMap
    destroy loo_SbMap
    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:
li_TotalItemCount = loo_Json.IntOf("totalItemCount")
Write-Debug "totalItemCount = " + string(li_TotalItemCount)

li_ChildFolderCount = loo_Json.IntOf("childFolderCount")
Write-Debug "childFolderCount = " + string(li_ChildFolderCount)

// etc..


destroy loo_Http
destroy loo_SbResponse
destroy loo_Json
destroy loo_HtFolderMap
destroy loo_SbMap