PureBasic

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

PureBasic

IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHashtable.pb"

Procedure ChilkatExample()

    success.i = 0

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

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

    CkHttp::setCkAuthToken(http, "MICROSOFT_GRAPH_ACCESS_TOKEN")

    sbResponse.i = CkStringBuilder::ckCreate()
    If sbResponse.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; This gets the combined total number of emails in all folders.
    success = CkHttp::ckQuickGetSb(http,"https://graph.microsoft.com/v1.0/me/messages/$count",sbResponse)
    If (success <> 1) AND (CkHttp::ckLastStatus(http) = 0)
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponse)
        ProcedureReturn
    EndIf

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::setCkEmitCompact(json, 0)

    ; If the status code was not 200, then it failed and the response is likely JSON:
    If CkHttp::ckLastStatus(http) <> 200
        Debug "Status code = " + Str(CkHttp::ckLastStatus(http))
        CkJsonObject::ckLoadSb(json,sbResponse)
        Debug CkJsonObject::ckEmit(json)
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponse)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    ; A success response payload contains just the integer value (it is not JSON)
    Debug "Combined Total Number of Emails = " + CkStringBuilder::ckGetAsString(sbResponse)
    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)
    htFolderMap.i = CkHashtable::ckCreate()
    If htFolderMap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    sbMap.i = CkStringBuilder::ckCreate()
    If sbMap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkStringBuilder::ckLoadFile(sbMap,"qa_data/outlook/folderMap.xml","utf-8")
    CkHashtable::ckAddFromXmlSb(htFolderMap,sbMap)

    ; Get the ID for the "/Inbox/abc" folder:
    folderId.s = CkHashtable::ckLookupStr(htFolderMap,"/Inbox/abc")
    If CkHashtable::ckLastMethodSuccess(htFolderMap) <> 1
        Debug "Folder ID not found"
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponse)
        CkJsonObject::ckDispose(json)
        CkHashtable::ckDispose(htFolderMap)
        CkStringBuilder::ckDispose(sbMap)
        ProcedureReturn
    EndIf

    CkHttp::ckSetUrlVar(http,"folder_id",folderId)

    ; Send the request get the folder information.
    ; In this case we are NOT using the $count system query option.
    success = CkHttp::ckQuickGetSb(http,"https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}",sbResponse)
    If (success <> 1) AND (CkHttp::ckLastStatus(http) = 0)
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponse)
        CkJsonObject::ckDispose(json)
        CkHashtable::ckDispose(htFolderMap)
        CkStringBuilder::ckDispose(sbMap)
        ProcedureReturn
    EndIf

    CkJsonObject::ckLoadSb(json,sbResponse)
    Debug CkJsonObject::ckEmit(json)
    Debug "--"

    If CkHttp::ckLastStatus(http) <> 200
        Debug "Status code = " + Str(CkHttp::ckLastStatus(http))
        Debug "Failed."
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbResponse)
        CkJsonObject::ckDispose(json)
        CkHashtable::ckDispose(htFolderMap)
        CkStringBuilder::ckDispose(sbMap)
        ProcedureReturn
    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:
    totalItemCount.i = CkJsonObject::ckIntOf(json,"totalItemCount")
    Debug "totalItemCount = " + Str(totalItemCount)

    childFolderCount.i = CkJsonObject::ckIntOf(json,"childFolderCount")
    Debug "childFolderCount = " + Str(childFolderCount)

    ; etc..


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbResponse)
    CkJsonObject::ckDispose(json)
    CkHashtable::ckDispose(htFolderMap)
    CkStringBuilder::ckDispose(sbMap)


    ProcedureReturn
EndProcedure