Lua

Copy an IMAP Message to Another Mailbox

Demonstrates the Chilkat Imap.Copy method, which copies one message from the currently selected mailbox to a destination mailbox. The first argument identifies the source message; the second (bUid) indicates whether the id is a UID (true) or a sequence number (false). This example copies a message from the Inbox to another mailbox.

Background: Messages can be identified two ways in IMAP: a sequence number (the message's current 1-based position, which shifts as messages are added or expunged) or a UID (a stable identifier that doesn't change). The bUid flag tells Copy which you're passing. Copying leaves the original in place and places a duplicate in the destination — use MoveMessages to relocate instead of duplicate.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Imap.Copy method, which copies one message from the currently selected
-- mailbox to a destination mailbox.  The 1st argument identifies the source message; the 2nd
-- (bUid) indicates whether the id is a UID (true) or a sequence number (false).

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

-- Select the source mailbox.
success = imap:select_mailbox("Inbox")
if not success then
    print(imap.last_error_text)
    return
end

-- Copy message sequence number 1 to the "Archive2026" mailbox.  bUid = false means the id
-- is a sequence number, not a UID.
success = imap:copy(1, false, "Archive2026")
if not success then
    print(imap.last_error_text)
    return
end

print("Message copied.")

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