Lianja

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

Download Chilkat for Lianja

Lianja

llSuccess = .F.

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

loImap = createobject("CkImap")

//  Open the SSH tunnel first.
lnSshPort = 22
llSuccess = loImap.SshOpenTunnel("ssh.example.com",lnSshPort)
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

//  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).
llSuccess = loImap.SshAuthenticatePw("sshUser",lcSshPassword)
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

//  With the SSH tunnel in place, connect and log in to the IMAP server as usual.  The IMAP
//  traffic flows through the tunnel automatically.
loImap.Ssl = .T.
loImap.Port = 993
llSuccess = loImap.Connect("imap.example.com")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

llSuccess = loImap.Login("user@example.com","myPassword")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

llSuccess = loImap.Disconnect()
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif

llSuccess = loImap.SshCloseTunnel()
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    return
endif



release loImap