Visual FoxPro

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 Visual FoxPro Downloads

Download Chilkat for Visual FoxPro

Visual FoxPro

LOCAL lnSuccess
LOCAL loImap
LOCAL lnSshPort
LOCAL lcSshPassword

lnSuccess = 0

*  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.

loImap = CreateObject('Chilkat.Imap')

lnSshPort = 22
lnSuccess = loImap.SshOpenTunnel("ssh.example.com",lnSshPort)
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

*  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.

lnSuccess = loImap.SshAuthenticatePw("sshUser",lcSshPassword)
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

*  With the SSH tunnel in place, connect and log in to the IMAP server as usual.  The IMAP
*  traffic flows through the tunnel automatically.
loImap.Ssl = 1
loImap.Port = 993
lnSuccess = loImap.Connect("imap.example.com")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

lnSuccess = loImap.Login("user@example.com","myPassword")
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

*  ... use the IMAP connection ...

lnSuccess = loImap.Disconnect()
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

*  Close the SSH tunnel.  Do not use the IMAP connection after this point.
lnSuccess = loImap.SshCloseTunnel()
IF (lnSuccess = 0) THEN
    ? loImap.LastErrorText
    RELEASE loImap
    CANCEL
ENDIF

RELEASE loImap