Sample code for 30+ languages & platforms
Lianja

Share an Existing SSH Tunnel (Socket) with IMAP

See more IMAP Examples

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

Lianja
llSuccess = .F.

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

loImap = createobject("CkImap")

//  Open and authenticate an SSH tunnel on a Socket object.  This tunnel can be shared with
//  other Chilkat objects.
loSshTunnel = createobject("CkSocket")
lnSshPort = 22
llSuccess = loSshTunnel.SshOpenTunnel("ssh.example.com",lnSshPort)
if (llSuccess = .F.) then
    ? loSshTunnel.LastErrorText
    release loImap
    release loSshTunnel
    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.

llSuccess = loSshTunnel.SshAuthenticatePw("sshUser",lcSshPassword)
if (llSuccess = .F.) then
    ? loSshTunnel.LastErrorText
    release loImap
    release loSshTunnel
    return
endif

//  Tell the Imap object to use the existing tunnel.
llSuccess = loImap.UseSshTunnel(loSshTunnel)
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    release loSshTunnel
    return
endif

//  Now connect and log in to the IMAP server through the tunnel.
loImap.Ssl = .T.
loImap.Port = 993
llSuccess = loImap.Connect("imap.example.com")
if (llSuccess = .F.) then
    ? loImap.LastErrorText
    release loImap
    release loSshTunnel
    return
endif

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

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



release loImap
release loSshTunnel