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

    -- In the following call to loadlib, change the path (./chilkat.dll) to the relative or absolute directory where the chilkat.dll, chilkat.so, or chilkat.dylib is located.
    chilkat = assert(package.loadlib("./chilkat.dll", "luaopen_chilkat"))()
    print(chilkat._VERSION)

    local success = false

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

    local imap = chilkat.newImap{}

    --  Connect to an IMAP server.
    --  Use TLS
    imap:setSsl(true)
    imap:setPort(993)
    success = imap:Connect("imap.example.com")
    if success == false then
        print(imap:LastErrorText())

    end

    --  Login
    success = imap:Login("***","***")
    if success == false then
        print(imap:LastErrorText())

    end

    --  Select an IMAP mailbox
    success = imap:SelectMailbox("Inbox")
    if success == false then
        print(imap:LastErrorText())

    end

    local emailHeader = chilkat.newEmail{}
    local emailFull = chilkat.newEmail{}

    local uid = 2014
    local isUid = true

    --  Fetch only the email header
    success = imap:FetchEmail(true,uid,isUid,emailHeader)
    if success == false then
        print(imap:LastErrorText())

    end

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

    end

    success = imap:FetchEmail(false,uid,isUid,emailFull)
    if success == false then
        print(imap:LastErrorText())

    end

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

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