Lua

Authenticate an IMAP SSH Tunnel with a Password

Demonstrates the Chilkat Imap.SshAuthenticatePw method, which authenticates the SSH tunnel using a username and password. The first argument is the SSH login name and the second is the SSH password. Call SshOpenTunnel first; after SSH authentication succeeds, connect and log in to IMAP.

Background: This is SSH authentication, which is entirely separate from the IMAP login that follows — the SSH credentials belong to the tunnel/jump host, while the IMAP credentials belong to the mail account. Password authentication is the simplest option; use SshAuthenticatePk for key-based authentication, which is generally preferred for automated jobs.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Imap.SshAuthenticatePw method, which authenticates the SSH tunnel with a
-- username and password.  The 1st argument is the SSH login name and the 2nd is the SSH
-- password.  Call SshOpenTunnel first.

local imap = chilkat.Imap.new()

-- Open the SSH tunnel first.
local sshPort = 22
local success = imap:ssh_open_tunnel("ssh.example.com", sshPort)
if not success then
    print(imap.last_error_text)
    return
end

-- The SSH password is not hard-coded in source.  Insert code here to obtain it from an
-- interactive prompt, environment variable, or a secrets vault.
local sshPassword = ""

-- Authenticate the SSH tunnel (this is SSH authentication, separate from IMAP login).
success = imap:ssh_authenticate_pw("sshUser", sshPassword)
if not success then
    print(imap.last_error_text)
    return
end

-- With the SSH tunnel in place, connect and log in to the IMAP server as usual.  The IMAP
-- traffic flows through the tunnel automatically.
imap.ssl = true
imap.port = 993
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:disconnect()
if not success then
    print(imap.last_error_text)
    return
end

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