Go

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

Go

    success := false

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

    http := chilkat.NewHttp()

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

    http.SetAuthToken("MICROSOFT_GRAPH_ACCESS_TOKEN")

    sbResponse := chilkat.NewStringBuilder()

    // This gets the combined total number of emails in all folders.
    success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/messages/$count",sbResponse)
    if (success != true) && (http.LastStatus() == 0) {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        sbResponse.DisposeStringBuilder()
        return
    }

    json := chilkat.NewJsonObject()
    json.SetEmitCompact(false)

    // If the status code was not 200, then it failed and the response is likely JSON:
    if http.LastStatus() != 200 {
        fmt.Println("Status code = ", http.LastStatus())
        json.LoadSb(sbResponse)
        fmt.Println(*json.Emit())
        fmt.Println("Failed.")
        http.DisposeHttp()
        sbResponse.DisposeStringBuilder()
        json.DisposeJsonObject()
        return
    }

    // A success response payload contains just the integer value (it is not JSON)
    fmt.Println("Combined Total Number of Emails = ", *sbResponse.GetAsString())
    fmt.Println("--")

    // ---------------------------------------------------------------------------
    // 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 := chilkat.NewHashtable()
    sbMap := chilkat.NewStringBuilder()
    sbMap.LoadFile("qa_data/outlook/folderMap.xml","utf-8")
    htFolderMap.AddFromXmlSb(sbMap)

    // Get the ID for the "/Inbox/abc" folder:
    folderId := htFolderMap.LookupStr("/Inbox/abc")
    if htFolderMap.LastMethodSuccess() != true {
        fmt.Println("Folder ID not found")
        http.DisposeHttp()
        sbResponse.DisposeStringBuilder()
        json.DisposeJsonObject()
        htFolderMap.DisposeHashtable()
        sbMap.DisposeStringBuilder()
        return
    }

    http.SetUrlVar("folder_id",*folderId)

    // Send the request get the folder information.
    // In this case we are NOT using the $count system query option.
    success = http.QuickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}",sbResponse)
    if (success != true) && (http.LastStatus() == 0) {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        sbResponse.DisposeStringBuilder()
        json.DisposeJsonObject()
        htFolderMap.DisposeHashtable()
        sbMap.DisposeStringBuilder()
        return
    }

    json.LoadSb(sbResponse)
    fmt.Println(*json.Emit())
    fmt.Println("--")

    if http.LastStatus() != 200 {
        fmt.Println("Status code = ", http.LastStatus())
        fmt.Println("Failed.")
        http.DisposeHttp()
        sbResponse.DisposeStringBuilder()
        json.DisposeJsonObject()
        htFolderMap.DisposeHashtable()
        sbMap.DisposeStringBuilder()
        return
    }

    // 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 := json.IntOf("totalItemCount")
    fmt.Println("totalItemCount = ", totalItemCount)

    childFolderCount := json.IntOf("childFolderCount")
    fmt.Println("childFolderCount = ", childFolderCount)

    // etc..

    http.DisposeHttp()
    sbResponse.DisposeStringBuilder()
    json.DisposeJsonObject()
    htFolderMap.DisposeHashtable()
    sbMap.DisposeStringBuilder()