Lua

Set or Clear a Flag on a MessageSet

Demonstrates the Chilkat Imap.SetFlags method, which sets or clears a flag on every message in a MessageSet. The first argument is the MessageSet, the second is the flag name, and the third is the value (1 to set the flag, 0 to clear it). This example marks all unseen messages as Seen.

Background: IMAP flags are per-message keywords the server stores and shares across all clients. The standard system flags are Seen, Answered, Flagged, Deleted, Draft, and Recent. Give the flag name without the leading backslash here (use "Seen", not "\Seen"). SetFlags applies the change to the whole set in one round trip, which is how a client implements "mark all as read."

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Imap.SetFlags method, which sets or clears a flag on every message in a
-- MessageSet.  The 1st argument is the MessageSet, the 2nd is the flag name, and the 3rd is
-- the value (1 to set the flag, 0 to clear it).

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

-- Find the messages to flag (here, all unseen messages, by UID).
local msgSet = chilkat.MessageSet.new()
success = imap:query_mbx("UNSEEN", true, msgSet)
if not success then
    print(imap.last_error_text)
    return
end

-- Mark all of them as seen.  A value of 1 sets the flag; 0 would clear it.
success = imap:set_flags(msgSet, "Seen", 1)
if not success then
    print(imap.last_error_text)
    return
end

print("Marked " .. msgSet.count .. " messages as Seen.")

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