VB.NET

Route IMAP Through an Existing Ssh Connection

Demonstrates the Chilkat Imap.UseSsh method, which uses an already connected and authenticated Ssh object as the transport for IMAP connections. The only argument is the Ssh object. Call it before Connect. This example establishes the SSH connection separately, then routes IMAP through it.

Background: SSH supports multiple logical channels over one connection, so a single authenticated Ssh object can be shared — IMAP, SMTP, and other Chilkat objects can all tunnel through the same SSH session. This differs from SshOpenTunnel, where the Imap object owns and manages the tunnel itself; with UseSsh you manage the Ssh object's lifetime.

Chilkat VB.NET Downloads

Download Chilkat for VB.NET

VB.NET

Dim success As Boolean = False

'  Demonstrates the Imap.UseSsh method, which uses an already connected and authenticated Ssh
'  object as the transport for IMAP connections.  The only argument is the Ssh object.  Call it
'  before Connect.

Dim imap As New Chilkat.Imap

'  Establish and authenticate the SSH connection separately.
Dim ssh As New Chilkat.Ssh
Dim sshPort As Integer = 22
success = ssh.Connect("ssh.example.com",sshPort)
If (success = False) Then
    Debug.WriteLine(ssh.LastErrorText)
    Exit Sub
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 = ssh.AuthenticatePw("sshUser",sshPassword)
If (success = False) Then
    Debug.WriteLine(ssh.LastErrorText)
    Exit Sub
End If


'  Use the SSH connection as the transport for IMAP.  One SSH connection can be shared by
'  several Chilkat objects because SSH supports multiple channels.
success = imap.UseSsh(ssh)
If (success = False) Then
    Debug.WriteLine(imap.LastErrorText)
    Exit Sub
End If


'  Now connect and log in to the IMAP server through the SSH connection.
imap.Ssl = True
imap.Port = 993
success = imap.Connect("imap.example.com")
If (success = False) Then
    Debug.WriteLine(imap.LastErrorText)
    Exit Sub
End If

success = imap.Login("user@example.com","myPassword")
If (success = False) Then
    Debug.WriteLine(imap.LastErrorText)
    Exit Sub
End If


success = imap.Disconnect()
If (success = False) Then
    Debug.WriteLine(imap.LastErrorText)
    Exit Sub
End If