Close an IMAP SSH Tunnel

See more IMAP Examples

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.

import { Imap } from '@chilkat/react-native'

async function chilkatExample() {
  // 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.

  const imap = new Imap();

  const sshPort = 22;
  try {
    await imap.sshOpenTunnelAsync('ssh.example.com', sshPort);
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  // 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.
  const sshPassword = '';

  try {
    await imap.sshAuthenticatePwAsync('sshUser', sshPassword);
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  // 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;
  try {
    await imap.connectAsync('imap.example.com');
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  try {
    await imap.loginAsync('user@example.com', 'myPassword');
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  // ... use the IMAP connection ...

  try {
    await imap.disconnectAsync();
  } catch {
    console.log(imap.lastErrorText);
    return;
  }

  // Close the SSH tunnel.  Do not use the IMAP connection after this point.
  try {
    await imap.sshCloseTunnelAsync();
  } catch {
    console.log(imap.lastErrorText);
    return;
  }
}