Xojo Plugin

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 Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

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

Dim imap As New Chilkat.Imap

//  Open and authenticate an SSH tunnel on a Socket object.  This tunnel can be shared with
//  other Chilkat objects.
Dim sshTunnel As New Chilkat.Socket
Dim sshPort As Int32
sshPort = 22
success = sshTunnel.SshOpenTunnel("ssh.example.com",sshPort)
If (success = False) Then
    System.DebugLog(sshTunnel.LastErrorText)
    Return
End If

//  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.
Dim sshPassword As String

success = sshTunnel.SshAuthenticatePw("sshUser",sshPassword)
If (success = False) Then
    System.DebugLog(sshTunnel.LastErrorText)
    Return
End If

//  Tell the Imap object to use the existing tunnel.
success = imap.UseSshTunnel(sshTunnel)
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

//  Now connect and log in to the IMAP server through the tunnel.
imap.Ssl = True
imap.Port = 993
success = imap.Connect("imap.example.com")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

success = imap.Login("user@example.com","myPassword")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

success = imap.Disconnect()
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If