Zig

IMAP Get List of Flags

See more IMAP Examples

When a mailbox is selected, the server response includes a list of flags:

The FLAGS response occurs as a result of a SELECT or EXAMINE command. The flag parenthesized list identifies the flags (at a minimum, the system-defined flags) that are applicable for this mailbox. Flags other than the system flags can also exist, depending on server implementation.

This example demonstrates how to capture the SELECT (or EXAMINE) response, and parse the list of flags. Zig

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

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

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

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

    // Connect to an IMAP server.
    // Use TLS
    imap.setSsl(true);
    imap.setPort(993);
    imap.connect("MY-IMAP-DOMAIN") catch {
        std.debug.print("{s}\n", .{try imap.getLastErrorText(alloc)});
        return;
    };

    // Login
    imap.login("MY-IMAP-LOGIN", "MY-IMAP-PASSWORD") catch {
        std.debug.print("{s}\n", .{try imap.getLastErrorText(alloc)});
        return;
    };

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

    // The LastResponse property contains the full response of the last command.
    const select_response = try imap.getLastResponse(alloc);
    std.debug.print("{s}\n", .{select_response});

    // For example, on GMail, the SELECT response looks like this:

    //     * FLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk)
    //     * OK [PERMANENTFLAGS (\Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk \*)] Flags permitted.
    //     * OK [UIDVALIDITY 3] UIDs valid.
    //     * 46 EXISTS
    //     * 0 RECENT
    //     * OK [UIDNEXT 4147] Predicted next UID.
    //     * OK [HIGHESTMODSEQ 402971]
    //     aaac OK [READ-WRITE] INBOX selected. (Success)

    // The goal of this example is to capture the list of FLAGS.
    // All IMAP servers will respond with the list of flags in a SPACE separated list enclosed in parentheses.

    const sb_response = try chilkat.StringBuilder.init();
    defer sb_response.deinit();
    sb_response.append(select_response) catch {};

    // Get just the list of flags:
    const sb_flag_list = try chilkat.StringBuilder.init();
    defer sb_flag_list.deinit();
    sb_flag_list.append(try sb_response.getAfterBetween(alloc, "* FLAGS", "(", ")")) catch {};
    std.debug.print("{s}\n", .{try sb_flag_list.getAsString(alloc)});

    // sbFlagList contains this:
    //
    //     \Answered \Flagged \Draft \Deleted \Seen $Forwarded $NotPhishing $Phishing $label1 $label2 $label3 $label4 $label5 Junk NonJunk
    //

    // Make sure no more than one SPACE char in a row exists.
    sb_flag_list.trimInsideSpaces() catch {};
    // Modify sbFlagList to one flag per line
    _ = sb_flag_list.replace(" ", "\r\n");

    // Load a StringTable with the flag names.
    const flags_table = try chilkat.StringTable.init();
    defer flags_table.deinit();
    flags_table.appendFromSb(sb_flag_list) catch {};

    // Iterate over the individual flag names:
    var i: i32 = 0;
    while (i < flags_table.getCount()) {
        std.debug.print("{d}: {s}\n", .{ i, try flags_table.stringAt(alloc, i) });
        i = i + 1;
    }

    // The output is:
    //
    //     0: \Answered
    //     1: \Flagged
    //     2: \Draft
    //     3: \Deleted
    //     4: \Seen
    //     5: $Forwarded
    //     6: $NotPhishing
    //     7: $Phishing
    //     8: $label1
    //     9: $label2
    //     10: $label3
    //     11: $label4
    //     12: $label5
    //     13: Junk
    //     14: NonJunk
    //
}