Lua Requires Chilkat v11.0.0+

Fetch Full Email Given Email Header

When you fetch email headers using UIDs instead of sequence numbers, the email object (which includes only the header) will have auto-generated ckx-imap-* headers. These headers provide details like the UID and attachments. The IMAP UID is found in the ckx-imap-uid header. Additionally, the ckx-imap-isUid header indicates whether the email header was downloaded by UID, showing YES or NO. Since sequence numbers can change if emails are deleted, UIDs are essential for downloading the correct full email.

The Chilkat Email object offers a GetImapUid method to retrieve the UID from the ckx-imap-uid header. This UID can be used to fetch the full email.

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("***", "***")
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 emailHeader = chilkat.Email.new()
local emailFull = chilkat.Email.new()

local uid = 2014
local isUid = true

-- Fetch only the email header
success = imap:fetch_email(true, uid, isUid, emailHeader)
if not success then
    print(imap.last_error_text)
    return
end

-- Now fetch the full email
local uidFromCkxHeader = emailHeader:get_imap_uid()
if uidFromCkxHeader < 0 then
    -- Failed.
    print("No ckx-imap-uid header was found.")
    return
end

success = imap:fetch_email(false, uid, isUid, emailFull)
if not success then
    print(imap.last_error_text)
    return
end

-- OK, we have the full email, do whatever we want...

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