Chilkat2-Python

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 Chilkat2-Python Downloads

Download Chilkat for Chilkat2-Python

Chilkat2-Python

import sys
import chilkat2

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 = chilkat2.Imap()

# Open the SSH tunnel first.
sshPort = 22
success = imap.SshOpenTunnel("ssh.example.com",sshPort)
if (success == False):
    print(imap.LastErrorText)
    sys.exit()

# 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)
    sys.exit()

# 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 (success == False):
    print(imap.LastErrorText)
    sys.exit()

success = imap.Login("user@example.com","myPassword")
if (success == False):
    print(imap.LastErrorText)
    sys.exit()

success = imap.Disconnect()
if (success == False):
    print(imap.LastErrorText)
    sys.exit()

success = imap.SshCloseTunnel()
if (success == False):
    print(imap.LastErrorText)
    sys.exit()