Lua

Store One or More Flags on a Single Message

Demonstrates the Chilkat Imap.StoreFlags method, which sets or clears one or more flags on a single message identified by ID. The first argument is the message ID, the second (bUid) selects UID vs sequence number, the third is a space-separated list of flag names, and the fourth is the value (1 to set, 0 to clear). This example applies the Seen and Flagged flags to one message by UID.

Background: StoreFlags is the single-message counterpart to SetFlags and lets you change several flags at once by listing them space-separated (without leading backslashes). Because the ID can be either a UID or a sequence number, the bUid argument must match how you obtained it — a UID from a UID search, or a sequence number from a sequence-based operation. UIDs are the safer choice since they remain valid as the mailbox changes.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Imap.StoreFlags method, which sets or clears one or more flags on a single
-- message identified by ID.  The 1st argument is the message ID, the 2nd (bUid) selects UID
-- vs sequence number, the 3rd is a space-separated list of flag names, and the 4th is the
-- value (1 to set, 0 to clear).

local imap = chilkat.Imap.new()

imap.ssl = true
imap.port = 993

local success = imap:connect("imap.example.com")
if not success then
    print(imap.last_error_text)
    return
end

success = imap:login("user@example.com", "myPassword")
if not success then
    print(imap.last_error_text)
    return
end

success = imap:select_mailbox("Inbox")
if not success then
    print(imap.last_error_text)
    return
end

-- Get the UIDs of all messages.
local msgSet = chilkat.MessageSet.new()
success = imap:query_mbx("ALL", true, msgSet)
if not success then
    print(imap.last_error_text)
    return
end

if msgSet.count > 0 then
    -- Apply the Seen and Flagged flags to the first message.  bUid is true because the ID
    -- came from a UID search.
    local uid = msgSet:get_id(0)
    success = imap:store_flags(uid, true, "Seen Flagged", 1)
    if not success then
        print(imap.last_error_text)
        return
    end

    print("Updated flags on UID " .. uid)
end

success = imap:disconnect()
if not success then
    print(imap.last_error_text)
    return
end