Zig Requires Chilkat v11.0.0+

IMAP Search with THREAD Semantics

See more IMAP Examples

Demonstrates how to search an IMAP mailbox and return message numbers grouped together in parent/child relationships based on which messages are replies to others. Zig

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

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

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

    const imap = try chilkat.Imap.init();
    defer imap.deinit();

    // Connect to your IMAP server and authenticate..
    imap.setSsl(true);
    imap.setPort(993);
    imap.connect("imap.mail.us-west-2.awsapps.com") catch {
        std.debug.print("{s}\n", .{try imap.getLastErrorText(alloc)});
        return;
    };

    imap.login("myLogin", "myPassword") catch {
        std.debug.print("{s}\n", .{try imap.getLastErrorText(alloc)});
        return;
    };

    // Select a mailbox
    imap.selectMailbox("Inbox") catch {
        std.debug.print("{s}\n", .{try imap.getLastErrorText(alloc)});
        return;
    };

    // Search for all message having the letter 'a' somewhere in the Subject,
    // and return the messages as JSON.
    const json = try chilkat.JsonObject.init();
    defer json.deinit();
    imap.queryThread("REFERENCES", "SUBJECT a", true, json) catch {
        std.debug.print("{s}\n", .{try imap.getLastErrorText(alloc)});
        return;
    };

    // The IMAP server will return a raw response with a format such as this:  (2)(3 6 (4 23)(44 7 96))

    // In tree form, it's like this:
    //
    //             -- 2
    //             -- 3
    //                 \-- 6
    //                    |-- 4
    //                    |      \-- 23
    //                    |
    //                    |-- 44
    //                               \-- 7
    //                                       \-- 96
    //

    // It means there are 2 main threads returned, but the 2nd thread splits into two sub-threads.
    // In total, we can think of it as 3 threads -- 2 main threads (with no parents) and one sub-thread w/ a parent.
    //
    // - The 1st thread contains the message 2, and has no parent thread.
    // - The 2nd thread contains the messages 3, 6, 4, 23, and has no parent thread.
    // - The 3rd thread contains the messages 44, 7, 96 and the parent thread is message 6.
    //

    // (Yes, this is all highly confusing...)

    // Chilkat will return the above sample response as JSON that looks like this:

    // {
    //   "threads": [
    //     [2],
    //     [3, 6, [4, 23], [44, 7, 96]]
    //   ]
    // }
    //

    // Use this online tool to generate parsing code from sample JSON:
    // Generate Parsing Code from JSON
    // In this case, the online tool can help you get a feel for how to write the JSON parsing code..

    const num_threads = json.sizeOfArray("threads");
    std.debug.print("The total number of top-level threads is {d}\n", .{num_threads});

    // Let's say we wanted to get the messages in the thread 3, 6, 4, 23.
    // We always follow the 1st branch to the bottom, ignoring the other branches.
    // For example, if we had  [3, 5, [4, 23, [55, 56, 57], [68, 69]], [44, 7, 96]]
    // then the thread would be 3, 5, 4, 43, 55, 56, 57

    // For testing, let's substitute the response from the IMAP server with this sample:
    json.load("{\"threads\": [[2], [3, 5, [4, 23, [55, 56, 57], [68, 69]], [44, 7, 96]]]}") catch {};

    // Begin with the 2nd top-level thread, which is at index 1.
    std.debug.print("Following the 2nd top level thread...\n", .{});
    var arr: chilkat.JsonArray = try json.arrayOf("threads[1]");
    defer arr.deinit();
    var thread_size: i32 = arr.getSize();
    var i: i32 = 0;
    while (i < thread_size) {
        // Do we have an array or integer at this position?
        if (arr.typeAt(i) == 4) {
            // This is a sub-array.
            const sub_arr = try arr.arrayAt(i);
            defer sub_arr.deinit();

            // Follow the sub-array starting at the 1st position..
            arr = sub_arr;
            i = 0;
            thread_size = arr.getSize();
        } else {
            // Must be a single integer.
            std.debug.print("{d}\n", .{arr.intAt(i)});
            i = i + 1;
        }
    }

    // The output is:
    //
    // Following the 2nd top level thread...
    // 3
    // 5
    // 4
    // 23
    // 55
    // 56
    // 57
}