Lua Requires Chilkat v11.0.0+

Move Selected Emails to another Mailbox Folder

See more IMAP Examples

Downloads emails one by one in a selected mailbox, decides which emails are to be moved, and then moves the set of messages to another mailbox folder. 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 an IMAP server.
-- Use TLS
imap.ssl = true
imap.port = 993
local success = imap:connect("imap.example.com")
if not success then
    print(imap.last_error_text)
    return
end

-- Login
success = imap:login("myLogin", "myPassword")
if not success then
    print(imap.last_error_text)
    return
end

-- Select an IMAP mailbox
success = imap:select_mailbox("Inbox")
if not success then
    print(imap.last_error_text)
    return
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.peek_mode = 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 numEmails = imap.num_messages

local mset = chilkat.MessageSet.new()

-- Indicate that mset contains sequence numbers, not UIDs.
mset.has_uids = false

-- Fetch each email and decide for each if it is to be moved
-- to a particular other mailbox.  If so, we'll add the sequence number to
-- the mset, and then move all emails in the mset to the other mailbox.
local email = chilkat.Email.new()
local i = 0
while i < numEmails do
    -- Fetch the email by sequence number.
    success = imap:fetch_email(false, i + 1, false, email)
    if not success then
        print(imap.last_error_text)
        return
    end

    -- If it is decided to move the email, add the sequence number to mset, like this:
    mset:insert_id(i + 1)
end

-- If there are emails in mset to be moved, then do it..
if mset.count > 0 then
    local destFolder = "Inbox/SomeOtherFolder"
    -- Assuming your IMAP server supports the feature that allows for messages to be moved to another folder...
    success = imap:move_messages(mset, destFolder)
    if not success then
        print(imap.last_error_text)
        return
    end
end

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