Lua

Delete an IMAP Mailbox

Demonstrates the Chilkat Imap.DeleteMailbox method, which deletes a mailbox from the IMAP server. This deletes the mailbox itself, not merely the messages it contains. This example deletes a mailbox named OldFolder.

Background: Deleting a mailbox removes the folder and everything in it — an irreversible action, so applications typically confirm first. Server rules can add constraints: some refuse to delete a folder that still has child folders, or that is currently selected. This is the counterpart to CreateMailbox; to remove individual messages rather than a whole folder, mark them deleted and Expunge.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Imap.DeleteMailbox method, which deletes a mailbox from the IMAP server.
-- This deletes the mailbox itself, not merely the messages it contains.

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

-- Delete a mailbox (folder) from the server.
success = imap:delete_mailbox("OldFolder")
if not success then
    print(imap.last_error_text)
    return
end

print("Mailbox deleted.")

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