Lua Requires Chilkat v11.0.0+

Read iCloud Email Account using IMAP

See more IMAP Examples

Demonstrates how to set the IMAP settings for an iCloud email account and downloads the email from Inbox. 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 the iCloud IMAP Mail Server
imap.ssl = true
imap.port = 993
local success = imap:connect("imap.mail.me.com")
if not success then
    print(imap.last_error_text)
    return
end

-- The username is usually the name part of your iCloud email address
-- (for example, emilyparker, not emilyparker@icloud.com).
success = imap:login("ICLOUD_USERNAME", "ICLOUD_PASSWORD")
if not success then
    print(imap.last_error_text)
    return
end

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

-- Once the folder/mailbox is selected, the NumMessages property
-- will contain the number of emails in the mailbox.
-- Loop from 1 to NumMessages to fetch each email by sequence number.

local email = chilkat.Email.new()
local n = imap.num_messages
local bUid = false
for i = 1, n do
    -- Download the email by sequence number.
    success = imap:fetch_email(false, i, bUid, email)
    if not success then
        print(imap.last_error_text)
        return
    end

    print(i .. ": " .. email.from)
    print("    " .. email.subject)
    print("-")
end

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

print("Success.")

-- Sample output:

--     1: iCloud <noreply@email.apple.com>
--         Welcome to iCloud Mail.
--     -
--     2: "Chilkat Software" <support@chilkatsoft.com>
--         This is a test
--     -
--     Success.