Ruby

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 Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  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.

imap = Chilkat::CkImap.new()

#  Open the SSH tunnel first.
sshPort = 22
success = imap.SshOpenTunnel("ssh.example.com",sshPort)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
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.

#  Authenticate the SSH tunnel (this is SSH authentication, separate from IMAP login).
success = imap.SshAuthenticatePw("sshUser",sshPassword)
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
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.put_Ssl(true)
imap.put_Port(993)
success = imap.Connect("imap.example.com")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

success = imap.Login("user@example.com","myPassword")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

success = imap.Disconnect()
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

success = imap.SshCloseTunnel()
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end