Xojo Plugin

Close the SSH Tunnel

Demonstrates the Chilkat MailMan.SshCloseTunnel method, which closes the SSH tunnel used for SMTP or POP3 communication. This example opens and authenticates a tunnel, performs a mail operation through it, and then closes it.

Background: An SSH tunnel holds an open connection to the SSH server for as long as it is needed, so closing it releases both that connection and the resources on the SSH server. The natural pattern is open → authenticate → do mail work → close. It is the counterpart to SshOpenTunnel, and is separate from closing the mail connections themselves (CloseSmtpConnection / Pop3EndSession), which ride inside the tunnel.

Chilkat Xojo Plugin Downloads

Download Chilkat for Xojo Plugin

Xojo Plugin

Dim success As Boolean
success = False

//  Demonstrates the MailMan.SshCloseTunnel method, which closes the SSH tunnel used for SMTP
//  or POP3 communication.

Dim mailman As New Chilkat.MailMan

//  Configure the POP3 server connection.
mailman.MailHost = "pop.example.com"
mailman.MailPort = 995
mailman.PopSsl = True
mailman.PopUsername = "user@example.com"
mailman.PopPassword = "myPassword"

//  Open and authenticate the SSH tunnel.
success = mailman.SshOpenTunnel("ssh.example.com",22)
If (success = False) Then
    System.DebugLog(mailman.LastErrorText)
    Return
End If

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

//  ... perform mail operations through the tunnel ...
Dim count As Int32
count = mailman.GetMailboxCount()
If (count < 0) Then
    System.DebugLog("Failed to get the mailbox count.")
Else
    System.DebugLog("Mailbox count: " + Str(count))
End If

//  Close the SSH tunnel when finished with it.
success = mailman.SshCloseTunnel()
If (success = False) Then
    System.DebugLog(mailman.LastErrorText)
    Return
End If

System.DebugLog("SSH tunnel closed.")