Zig

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

Zig

const std = @import("std");
const chilkat = @import("chilkat");

pub fn main(init: std.process.Init) !void {
    const alloc = init.arena.allocator();

    var success: bool = false;

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

    const http = try chilkat.Http.init();
    defer http.deinit();

    // 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");

    const sb_response = try chilkat.StringBuilder.init();
    defer sb_response.deinit();

    // This gets the combined total number of emails in all folders.
    success = if (http.quickGetSb("https://graph.microsoft.com/v1.0/me/messages/$count", sb_response)) true else |_| false;
    if ((!success) and (http.getLastStatus() == 0)) {
        std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
        return;
    }

    const json = try chilkat.JsonObject.init();
    defer json.deinit();
    json.setEmitCompact(false);

    // If the status code was not 200, then it failed and the response is likely JSON:
    if (http.getLastStatus() != 200) {
        std.debug.print("Status code = {d}\n", .{http.getLastStatus()});
        json.loadSb(sb_response) catch {};
        std.debug.print("{s}\n", .{try json.emit(alloc)});
        std.debug.print("Failed.\n", .{});
        return;
    }

    // A success response payload contains just the integer value (it is not JSON)
    std.debug.print("Combined Total Number of Emails = {s}\n", .{try sb_response.getAsString(alloc)});
    std.debug.print("--\n", .{});

    // ---------------------------------------------------------------------------
    // 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)
    const ht_folder_map = try chilkat.Hashtable.init();
    defer ht_folder_map.deinit();
    const sb_map = try chilkat.StringBuilder.init();
    defer sb_map.deinit();
    sb_map.loadFile("qa_data/outlook/folderMap.xml", "utf-8") catch {};
    ht_folder_map.addFromXmlSb(sb_map) catch {};

    // Get the ID for the "/Inbox/abc" folder:
    const folder_id = ht_folder_map.lookupStr(alloc, "/Inbox/abc") catch {
        std.debug.print("Folder ID not found\n", .{});
        return;
    };

    http.setUrlVar("folder_id", folder_id) catch {};

    // Send the request get the folder information.
    // In this case we are NOT using the $count system query option.
    success = if (http.quickGetSb("https://graph.microsoft.com/v1.0/me/mailFolders/{$folder_id}", sb_response)) true else |_| false;
    if ((!success) and (http.getLastStatus() == 0)) {
        std.debug.print("{s}\n", .{try http.getLastErrorText(alloc)});
        return;
    }

    json.loadSb(sb_response) catch {};
    std.debug.print("{s}\n", .{try json.emit(alloc)});
    std.debug.print("--\n", .{});

    if (http.getLastStatus() != 200) {
        std.debug.print("Status code = {d}\n", .{http.getLastStatus()});
        std.debug.print("Failed.\n", .{});
        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:
    const total_item_count = json.intOf("totalItemCount");
    std.debug.print("totalItemCount = {d}\n", .{total_item_count});

    const child_folder_count = json.intOf("childFolderCount");
    std.debug.print("childFolderCount = {d}\n", .{child_folder_count});

    // etc..
}