Lua

Close an IMAP SSH Tunnel

Demonstrates the Chilkat Imap.SshCloseTunnel method, which closes the SSH tunnel opened by SshOpenTunnel. It takes no arguments. Any IMAP connection that was using the tunnel must not be used after the tunnel is closed.

Background: The SSH tunnel is the transport that carries the IMAP session, so closing it tears down that transport. Disconnect or finish with the IMAP connection first, then close the tunnel to release the SSH resources cleanly. Continuing to use an IMAP connection whose tunnel has been closed will fail.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Imap.SshCloseTunnel method, which closes the SSH tunnel opened by
-- SshOpenTunnel.  It takes no arguments.  Any IMAP connection using the tunnel must not be
-- used after the tunnel is closed.

local imap = chilkat.Imap.new()

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 = ""

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

-- ... use the IMAP connection ...

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

-- Close the SSH tunnel.  Do not use the IMAP connection after this point.
success = imap:ssh_close_tunnel()
if not success then
    print(imap.last_error_text)
    return
end