Lua

Open an SSH Tunnel for POP3

Demonstrates the Chilkat MailMan.SshOpenTunnel method, which connects to an SSH server and opens an SSH tunnel for MailMan's SMTP or POP3 connections. The first argument is the SSH server's hostname or IP address and the second is the SSH port. This example opens a tunnel, authenticates, performs a POP3 operation through it, and closes the tunnel.

Background: An SSH tunnel (port forwarding) wraps another protocol's traffic inside an encrypted SSH connection. Here, MailMan's POP3 or SMTP session is carried through the SSH server rather than connecting directly. This is useful when a mail server is only reachable from inside a network you can reach via SSH, or when policy requires all traffic to traverse a bastion host. Opening the tunnel is step one; you must then authenticate to the SSH server before the tunnel carries traffic.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the MailMan.SshOpenTunnel method, which connects to an SSH server and opens
-- an SSH tunnel for MailMan's SMTP or POP3 connections.  The 1st argument is the SSH server
-- hostname or IP address, and the 2nd is the SSH port.

local mailman = chilkat.MailMan.new()

-- Configure the POP3 server connection.  These connections will travel through the tunnel.
mailman.mail_host = "pop.example.com"
mailman.mail_port = 995
mailman.pop_ssl = true
mailman.pop_username = "user@example.com"
mailman.pop_password = "myPassword"

-- Open the SSH tunnel (port 22 is the standard SSH port).
local success = mailman:ssh_open_tunnel("ssh.example.com", 22)
if not success then
    print(mailman.last_error_text)
    return
end

-- Authenticate with the SSH server.
success = mailman:ssh_authenticate_pw("sshUser", "sshPassword")
if not success then
    print(mailman.last_error_text)
    return
end

-- POP3 operations now travel through the SSH tunnel.
local count = mailman:get_mailbox_count()
if count < 0 then
    print("Failed to get the mailbox count.")
else
    print("Mailbox count: " .. count)
end

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