Lua

Share an Existing SSH Tunnel (Socket) with IMAP

Demonstrates the Chilkat Imap.UseSshTunnel method, which uses an existing SSH tunnel, represented by a Socket object, for IMAP connections. The only argument is the Socket. Call it before Connect. This example opens and authenticates the tunnel on a Socket, then routes IMAP through it.

Background: A Socket object can open and hold an SSH tunnel that several Chilkat objects share. This is the approach when the tunnel is managed independently of any one protocol object — for example a long-lived tunnel reused across IMAP, POP3, and SMTP sessions — whereas SshOpenTunnel ties the tunnel's lifetime to the Imap object.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Imap.UseSshTunnel method, which uses an existing SSH tunnel (represented by
-- a Socket) for IMAP connections.  The only argument is the Socket.  Call it before Connect.

local imap = chilkat.Imap.new()

-- Open and authenticate an SSH tunnel on a Socket object.  This tunnel can be shared with
-- other Chilkat objects.
local sshTunnel = chilkat.Socket.new()
local sshPort = 22
local success = sshTunnel:ssh_open_tunnel("ssh.example.com", sshPort)
if not success then
    print(sshTunnel.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 = ""

success = sshTunnel:ssh_authenticate_pw("sshUser", sshPassword)
if not success then
    print(sshTunnel.last_error_text)
    return
end

-- Tell the Imap object to use the existing tunnel.
success = imap:use_ssh_tunnel(sshTunnel)
if not success then
    print(imap.last_error_text)
    return
end

-- Now connect and log in to the IMAP server through the tunnel.
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