Tcl

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

Download Chilkat for Tcl

Tcl


load ./chilkat.dll

set success 0

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

set imap [new_CkImap]

#  Open the SSH tunnel first.
set sshPort 22
set success [CkImap_SshOpenTunnel $imap "ssh.example.com" $sshPort]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    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).
set success [CkImap_SshAuthenticatePw $imap "sshUser" $sshPassword]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    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.
CkImap_put_Ssl $imap 1
CkImap_put_Port $imap 993
set success [CkImap_Connect $imap "imap.example.com"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

set success [CkImap_Login $imap "user@example.com" "myPassword"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

set success [CkImap_Disconnect $imap]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}

set success [CkImap_SshCloseTunnel $imap]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    exit
}


delete_CkImap $imap