Java

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

Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Hashtable;
import com.chilkatsoft.chilkat2.Http;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        boolean success = false;

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

        Http http = new 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).

        http.setAuthToken("MICROSOFT_GRAPH_ACCESS_TOKEN");

        StringBuilder sbResponse = new StringBuilder();

        // This gets the combined total number of emails in all folders.
        try {
            http.quickGetSb("https://graph.microsoft.com/v1.0/me/messages/$count", sbResponse);
            success = true;
        } catch (ChilkatException e) {
            success = false;
        }
        if ((!success) && (http.getLastStatus() == 0)) {
            System.out.println(http.getLastErrorText());
            return;
        }

        JsonObject json = new JsonObject();
        json.setEmitCompact(false);

        // If the status code was not 200, then it failed and the response is likely JSON:
        if (http.getLastStatus() != 200) {
            System.out.println("Status code = " + http.getLastStatus());
            json.loadSb(sbResponse);
            System.out.println(json.emit());
            System.out.println("Failed.");
            return;
        }

        // A success response payload contains just the integer value (it is not JSON)
        System.out.println("Combined Total Number of Emails = " + sbResponse.getAsString());
        System.out.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)
        Hashtable htFolderMap = new Hashtable();
        StringBuilder sbMap = new StringBuilder();
        sbMap.loadFile("qa_data/outlook/folderMap.xml", "utf-8");
        htFolderMap.addFromXmlSb(sbMap);

        // Get the ID for the "/Inbox/abc" folder:
        String folderId = htFolderMap.lookupStr("/Inbox/abc");
        if (folderId == null) {
            System.out.println("Folder ID not found");
            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.
        try {
            http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}", sbResponse);
            success = true;
        } catch (ChilkatException e) {
            success = false;
        }
        if ((!success) && (http.getLastStatus() == 0)) {
            System.out.println(http.getLastErrorText());
            return;
        }

        json.loadSb(sbResponse);
        System.out.println(json.emit());
        System.out.println("--");

        if (http.getLastStatus() != 200) {
            System.out.println("Status code = " + http.getLastStatus());
            System.out.println("Failed.");
            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:
        int totalItemCount = json.intOf("totalItemCount");
        System.out.println("totalItemCount = " + totalItemCount);

        int childFolderCount = json.intOf("childFolderCount");
        System.out.println("childFolderCount = " + childFolderCount);

        // etc..
    }
}