B4X

Close an IMAP SSH Tunnel

Demonstrates the Chilkat Imap.SshCloseTunnel method, which closes the SSH tunnel opened by SshOpenTunnel. It takes no arguments. Any IMAP connection that was using the tunnel must not be used after the tunnel is closed.

Background: The SSH tunnel is the transport that carries the IMAP session, so closing it tears down that transport. Disconnect or finish with the IMAP connection first, then close the tunnel to release the SSH resources cleanly. Continuing to use an IMAP connection whose tunnel has been closed will fail.

Chilkat B4X Downloads

Download Chilkat for B4X

B4X

Dim success As Boolean = False

'  Demonstrates the Imap.SshCloseTunnel method, which closes the SSH tunnel opened by
'  SshOpenTunnel.  It takes no arguments.  Any IMAP connection using the tunnel must not be
'  used after the tunnel is closed.

Dim imap As ChilkatImap
imap.Initialize("imap")

Dim sshPort As Int = 22
success = imap.SshOpenTunnel("ssh.example.com", sshPort)
If success = False Then
    Log(imap.LastErrorText)
    Return
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 = imap.SshAuthenticatePw("sshUser", sshPassword)
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


'  With the SSH tunnel in place, connect and log in to the IMAP server as usual.  The IMAP
'  traffic flows through the tunnel automatically.
imap.Ssl = True
imap.Port = 993
success = imap.Connect("imap.example.com")
If success = False Then
    Log(imap.LastErrorText)
    Return
End If

success = imap.Login("user@example.com", "myPassword")
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


'  ... use the IMAP connection ...

success = imap.Disconnect
If success = False Then
    Log(imap.LastErrorText)
    Return
End If


'  Close the SSH tunnel.  Do not use the IMAP connection after this point.
success = imap.SshCloseTunnel
If success = False Then
    Log(imap.LastErrorText)
    Return
End If