(VBScript) IMAP Use Existing SSH Tunnel

Demonstrates how to connect to an IMAP server using an existing SSH tunnel. This creates a new channel within the SSH tunnel, which can be a TCP or TLS connection, and is connected to a remote IMAP server through port forwarding.

Chilkat ActiveX Downloads

Dim fso, outFile
Set fso = CreateObject("Scripting.FileSystemObject")
Set outFile = fso.CreateTextFile("output.txt", True)
' Starting in v9.5.0.49, all Chilkat classes can be unlocked at once at the beginning of a program' by calling UnlockBundle. It requires a Bundle unlock code.set chilkatGlob = CreateObject("Chilkat_9_5_0.Global")
success = chilkatGlob.UnlockBundle("Anything for 30-day trial.")
If (success <> 1) Then
outFile.WriteLine(chilkatGlob.LastErrorText)
WScript.Quit
End Ifset tunnel = CreateObject("Chilkat_9_5_0.Socket")
sshHostname = "www.my-ssh-server.com"
sshPort = 22' Connect to an SSH server and establish the SSH tunnel:
success = tunnel.SshOpenTunnel(sshHostname,sshPort)
If (success <> 1) Then
outFile.WriteLine(tunnel.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 = tunnel.SshAuthenticatePw("mySshLogin","mySshPassword")
If (success <> 1) Then
outFile.WriteLine(tunnel.LastErrorText)
WScript.Quit
End If' OK, the SSH tunnel is setup. Now open a channel within the tunnel.' Once the channel is obtained, the Socket API may' be used exactly the same as usual, except all communications' are sent through the channel in the SSH tunnel.' Any number of channels may be created from the same SSH tunnel.' Multiple channels may coexist at the same time.set imap = CreateObject("Chilkat_9_5_0.Imap")
' Let the IMAP object also use the SSH tunnel
success = imap.UseSshTunnel(tunnel)
If (success <> 1) Then
outFile.WriteLine(imap.LastErrorText)
WScript.Quit
End If' Connect to an IMAP server via the already established 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.NumMessagesIf (msgCount = 0) Then
outFile.WriteLine("No messages found.")
WScript.Quit
End If
upperBound = 10If (msgCount < upperBound) Then
upperBound = msgCount
End If' Download up to the 1st 10 messages.
bUid = 0For i = 1To upperBound
' email is a Chilkat_9_5_0.Email
Set email = imap.FetchSingle(i,bUid)
If (email Is Nothing ) Then
outFile.WriteLine(imap.LastErrorText)
WScript.Quit
Else
outFile.WriteLine(email.From)
outFile.WriteLine(email.Subject)
outFile.WriteLine("----")
End IfNext' 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)
' This closes the SSH channel, which is the connection with the IMAP server.' It does not close the SSH tunnel
success = imap.Disconnect()
If (success <> 1) Then
outFile.WriteLine(imap.LastErrorText)
WScript.Quit
End If' Finally, close the SSH tunnel.' Note: If other objects are using the same SSH tunnel, the tunnel is not' actually closed. It is only closed when the last object using the tunnel closes it.' At this point, both the imap and tunnel objects have references to the internal' SSH tunnel. We need to close each.' This call doesn't actually close the tunnel yet, because the tunnel object still' holds an internal reference.
success = imap.SshCloseTunnel()
If (success <> 1) Then
outFile.WriteLine(imap.LastErrorText)
WScript.Quit
End If' This actually closes the SSH tunnel because it's the last object using it.
success = tunnel.SshCloseTunnel()
If (success <> 1) Then
outFile.WriteLine(tunnel.LastErrorText)
WScript.Quit
End If
outFile.WriteLine("IMAP pre-existing SSH tunnel example completed.")
outFile.Close