Lua Requires Chilkat v11.0.0+

Get IMAP UID from Email Header

See more IMAP Examples

Demonstrates how to get the IMAP UID from an email header. After fetching an email or header using IMAP, the UID is contained in the ckx-imap-uid header field. Lua

local chilkat = require("chilkat")

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

local imap = chilkat.Imap.new()

-- Connect to an IMAP server.
-- Use TLS
imap.ssl = true
imap.port = 993
local success = imap:connect("imap.example.com")
if not success then
    print(imap.last_error_text)
    return
end

-- Login
success = imap:login("login", "password")
if not success then
    print(imap.last_error_text)
    return
end

-- Select an IMAP mailbox
success = imap:select_mailbox("Inbox")
if not success then
    print(imap.last_error_text)
    return
end

local fetchUids = true
-- Get the message UIDs of all the emails in the mailbox

local messageSet = chilkat.MessageSet.new()
success = imap:query_mbx("ALL", fetchUids, messageSet)
if not success then
    print(imap.last_error_text)
    return
end

local bundle = chilkat.EmailBundle.new()
local headersOnly = true
success = imap:fetch_msg_set(headersOnly, messageSet, bundle)
if not success then
    print(imap.last_error_text)
    return
end

-- The UID of each fetched email header is available
-- in the ckx-imap-uid header field.
local email = chilkat.Email.new()
local msgSet1 = chilkat.MessageSet.new()
local i = 0
local szBundle = bundle.message_count
while i < szBundle do
    bundle:email_at(i, email)

    -- Build a message set containing one UID
    local uidStr = email:get_header_field("ckx-imap-uid")
    msgSet1:from_compact_string(uidStr)

    -- Move this message to some other folder.
    success = imap:move_messages(msgSet1, "someOtherFolder")
    if not success then
        print(imap.last_error_text)
        -- Exit the loop...
        i = szBundle
    end

    i = i + 1
end

-- Disconnect from the IMAP server.
success = imap:disconnect()