Lua Requires Chilkat v11.0.0+

Fetch Inbox Email Headers

Downloads the headers of all emails in the Inbox and shows some information about each, such as From, Subject, and whether the email has been seen (already read) or not. 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("myLogin","myPassword")
    if success == false then
        print(imap:LastErrorText())

    end

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

    end

    --  Normally, when an email is downloaded, its "Seen" flag is automatically set.
    --  We don't want our program to be interfering with the "Seen" flags.
    --  To do this, set the PeekMode to true.
    imap:setPeekMode(true)

    --  After selecting the mailbox, the NumMessages property
    --  will contain the number of emails in the mailbox.
    --  When sequence numbers (not UIDs) are used to reference emails,
    --  they range from 1 to N, where N is the number of messages in the mailbox.
    --  This example will download the headers by sequence numbers.
    local count = imap:NumMessages()

    local bundle = chilkat.newEmailBundle{}
    success = imap:FetchRange(true,1,count,bundle)
    if success == false then
        print(imap:LastErrorText())

    end

    if bundle:MessageCount() == 0 then
        print("No messages in Inbox.")

    end

    --  Loop over the email headers.  
    local emailHeader = chilkat.newEmail{}
    local i = 0
    while i < bundle:MessageCount() do

        bundle:EmailAt(i,emailHeader)

        print(emailHeader:From())
        print(emailHeader:Subject())

        --  Get the "Seen" flag.
        --  When an email is fetched from the IMAP server, the email flags are stored
        --  within the email in the "ckx-imap-flags" header.
        --  The call to GetMailFlag is simply getting the information from the email header.
        --  (it is not communicating with the IMAP server to get this information, because
        --  the information was obtained when downloading the headers)
        local seenFlag = imap:GetMailFlag(emailHeader,"Seen")
        if seenFlag == 1 then
            print("This email has been read (already seen)")
        else
            print("This email has not yet been read (it is not yet seen)")
        end

        --  We can also look directly at the "ckx-imap-flags" header:
        print("ckx-imap-flags: ", emailHeader:GetHeaderField("ckx-imap-flags"))

        print("--")

        i = i + 1
    end

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