(Xojo Plugin) IMAP SSH Tunneling (Port Forwarding)

Demonstrates how to setup and use an SSH tunnel for IMAP.

Chilkat Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

Dim imap As New Chilkat.Imap

// The SSH hostname may be a hostname or an 
// IP address, such as "192.168.1.108".
// The port is typically 22 (the standard port for SSH).
Dim sshHostname As String
sshHostname = "www.mysshserver.com"
Dim sshPort As Int32
sshPort = 22

// Connect to an SSH server and establish the SSH tunnel:
Dim success As Boolean
success = imap.SshOpenTunnel(sshHostname,sshPort)
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Authenticate with the SSH server via a login/password
// or with a public key.
// This example demonstrates SSH password authentication.
// Note: This is not authenticating with the IMAP server, it is
// for authenticating with the SSH server, which is separate.
success = imap.SshAuthenticatePw("mySshLogin","mySshPassword")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// OK, the SSH tunnel is setup.  The IMAP component may
// be used exactly the same as usual, except all communications
// are sent through the SSH tunnel.

// Connect to an IMAP server via the SSH tunnel.
// Because the SSH tunnel has been previously setup,
// this does not establish a direct connection with the IMAP
// server.  It directs the SSH server to establish the connection.

// In this example, the IMAP server requires SSL/TLS.  The TLS connection
// will be enclosed within the SSH tunnel.
imap.Ssl = True
imap.Port = 993
success = imap.Connect("imap.my-imap-server.com")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Authenticate with the IMAP server via the SSH tunnel.
success = imap.Login("myLogin","myPassword")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// How many messages in Inbox?
Dim msgCount As Int32
msgCount = imap.NumMessages
If (msgCount = 0) Then
    System.DebugLog("No messages found.")
    Return
End If

Dim upperBound As Int32
upperBound = 10
If (msgCount < upperBound) Then
    upperBound = msgCount
End If

// Download up to the 1st 10 messages.
Dim i As Int32
Dim bUid As Boolean
bUid = False
For i = 1 To upperBound

    Dim email As Chilkat.Email
    email = imap.FetchSingle(i,bUid)
    If (imap.LastMethodSuccess = False) Then
        System.DebugLog(imap.LastErrorText)
        Return

    Else
        System.DebugLog(email.From)
        System.DebugLog(email.Subject)
        System.DebugLog("----")

    End If

Next

// Disconnect from the IMAP server.
// The SSH tunnel remains open.
success = imap.Disconnect()
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// It is possible to re-use the existing SSH tunnel for the next connection:
success = imap.Connect("imap.my-imap-server2.com")
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Review the LastErrorText to see that the connection was made via the SSH tunnel:
System.DebugLog(imap.LastErrorText)

success = imap.Disconnect()
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Finally, close the SSH tunnel.
success = imap.SshCloseTunnel()
If (success <> True) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

System.DebugLog("IMAP SSH tunneling example completed.")