Lua

Connect to IMAP Through an SSH Tunnel

Demonstrates the Chilkat Imap.SshOpenTunnel method, which connects to an SSH server and prepares a tunnel through which a later IMAP connection is routed. The first argument is the SSH server hostname and the second is the SSH port (usually 22). After it succeeds, authenticate the tunnel, then call Connect and Login for the IMAP server.

Background: SSH tunneling (port forwarding) routes the IMAP session inside an encrypted SSH connection. It is used to reach a mail server that is only accessible from behind a bastion/jump host, or to add a second layer of transport security. The order is fixed: open the tunnel, authenticate to SSH, then connect and log in to IMAP — and close the tunnel with SshCloseTunnel when finished.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Imap.SshOpenTunnel method, which connects to an SSH server and prepares a
-- tunnel for a later IMAP connection.  The 1st argument is the SSH server hostname and the
-- 2nd is the SSH port (usually 22).

local imap = chilkat.Imap.new()

-- Open the SSH tunnel.  Port 22 is the usual SSH port.
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 with a username and password.
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

-- Close the tunnel when finished with the IMAP connection.
success = imap:ssh_close_tunnel()
if not success then
    print(imap.last_error_text)
    return
end