Tcl

Share an Existing SSH Tunnel (Socket) with IMAP

Demonstrates the Chilkat Imap.UseSshTunnel method, which uses an existing SSH tunnel, represented by a Socket object, for IMAP connections. The only argument is the Socket. Call it before Connect. This example opens and authenticates the tunnel on a Socket, then routes IMAP through it.

Background: A Socket object can open and hold an SSH tunnel that several Chilkat objects share. This is the approach when the tunnel is managed independently of any one protocol object — for example a long-lived tunnel reused across IMAP, POP3, and SMTP sessions — whereas SshOpenTunnel ties the tunnel's lifetime to the Imap object.

Chilkat Tcl Downloads

Download Chilkat for Tcl

Tcl


load ./chilkat.dll

set success 0

#  Demonstrates the Imap.UseSshTunnel method, which uses an existing SSH tunnel (represented by
#  a Socket) for IMAP connections.  The only argument is the Socket.  Call it before Connect.

set imap [new_CkImap]

#  Open and authenticate an SSH tunnel on a Socket object.  This tunnel can be shared with
#  other Chilkat objects.
set sshTunnel [new_CkSocket]

set sshPort 22
set success [CkSocket_SshOpenTunnel $sshTunnel "ssh.example.com" $sshPort]
if {$success == 0} then {
    puts [CkSocket_lastErrorText $sshTunnel]
    delete_CkImap $imap
    delete_CkSocket $sshTunnel
    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.

set success [CkSocket_SshAuthenticatePw $sshTunnel "sshUser" $sshPassword]
if {$success == 0} then {
    puts [CkSocket_lastErrorText $sshTunnel]
    delete_CkImap $imap
    delete_CkSocket $sshTunnel
    exit
}

#  Tell the Imap object to use the existing tunnel.
set success [CkImap_UseSshTunnel $imap $sshTunnel]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkSocket $sshTunnel
    exit
}

#  Now connect and log in to the IMAP server through the tunnel.
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
    delete_CkSocket $sshTunnel
    exit
}

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

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


delete_CkImap $imap
delete_CkSocket $sshTunnel