Lua

Create an IMAP Mailbox

Demonstrates the Chilkat Imap.CreateMailbox method, which creates a mailbox on the IMAP server. When creating nested mailboxes, use the server's hierarchy delimiter reported in the SeparatorChar property. This example creates a mailbox named Archive2026.

Background: IMAP folders form a hierarchy, and the character that separates levels varies by server — commonly / or .. To create a sub-folder you build the path with that delimiter (for example Archive/2026), which is why you should read SeparatorChar rather than assume one. Creating mailboxes lets an application organize mail into folders programmatically, such as filing messages by year or project.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Imap.CreateMailbox method, which creates a mailbox on the IMAP server.
-- Use the server's hierarchy delimiter (the SeparatorChar property) when creating nested
-- mailboxes.

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

-- Create a new mailbox (folder) on the server.
success = imap:create_mailbox("Archive2026")
if not success then
    print(imap.last_error_text)
    return
end

print("Mailbox created.")

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