Lua

Get the Number of IMAP Attachments

Demonstrates the Chilkat Imap.GetMailNumAttach method, which returns the number of ordinary attachments on a message. The only argument is the Email. This example fetches only the headers and reports the attachment count.

Background: A header-only fetch downloads no attachment bodies, so the Email object's own downloaded-attachment count can be 0. GetMailNumAttach instead reads the ckx-imap-numAttach metadata, giving the true count — which is what you want when building a message list that shows whether each message has attachments.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Imap.GetMailNumAttach method, which returns the number of ordinary
-- attachments on a message.  The only argument is the Email.

local imap = chilkat.Imap.new()

imap.ssl = true
imap.port = 993

local success = imap:connect("imap.example.com")
if not success then
    print(imap.last_error_text)
    return
end

success = imap:login("user@example.com", "myPassword")
if not success then
    print(imap.last_error_text)
    return
end

success = imap:select_mailbox("Inbox")
if not success then
    print(imap.last_error_text)
    return
end

-- Fetch only the message headers.  Attachment bodies are NOT downloaded, but the ckx-imap-*
-- metadata describing the attachments is present, so the attachment info methods still work.
local headersOnly = true
local useUid = false
local seqNum = 1
local email = chilkat.Email.new()
success = imap:fetch_email(headersOnly, seqNum, useUid, email)
if not success then
    print(imap.last_error_text)
    return
end

local numAttach = imap:get_mail_num_attach(email)
print("This message has " .. numAttach .. " attachment(s).")

success = imap:disconnect()
if not success then
    print(imap.last_error_text)
    return
end