(VBScript) IMAP SSH Tunneling (Port Forwarding)

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

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
'Create a Unicode (utf-16) output text file.
Set outFile = fso.CreateTextFile("output.txt", True, True)

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

' For versions of Chilkat < 10.0.0, use CreateObject("Chilkat_9_5_0.Imap")
set imap = CreateObject("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).
sshHostname = "www.mysshserver.com"
sshPort = 22

' Connect to an SSH server and establish the SSH tunnel:
success = imap.SshOpenTunnel(sshHostname,sshPort)
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
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 <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
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 = 1
imap.Port = 993
success = imap.Connect("imap.my-imap-server.com")
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' Authenticate with the IMAP server via the SSH tunnel.
success = imap.Login("myLogin","myPassword")
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' How many messages in Inbox?
msgCount = imap.NumMessages
If (msgCount = 0) Then
    outFile.WriteLine("No messages found.")
    WScript.Quit
End If

upperBound = 10
If (msgCount < upperBound) Then
    upperBound = msgCount
End If

' Download up to the 1st 10 messages.

bUid = 0
For i = 1 To upperBound

    ' email is a Chilkat.Email
    Set email = imap.FetchSingle(i,bUid)
    If (imap.LastMethodSuccess = 0) Then
        outFile.WriteLine(imap.LastErrorText)
        WScript.Quit

    Else
        outFile.WriteLine(email.From)
        outFile.WriteLine(email.Subject)
        outFile.WriteLine("----")

    End If

Next

' Disconnect from the IMAP server.
' The SSH tunnel remains open.
success = imap.Disconnect()
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
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 <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' Review the LastErrorText to see that the connection was made via the SSH tunnel:
outFile.WriteLine(imap.LastErrorText)

success = imap.Disconnect()
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

' Finally, close the SSH tunnel.
success = imap.SshCloseTunnel()
If (success <> 1) Then
    outFile.WriteLine(imap.LastErrorText)
    WScript.Quit
End If

outFile.WriteLine("IMAP SSH tunneling example completed.")

outFile.Close