React Native

Authenticate an IMAP SSH Tunnel with a Password

Demonstrates the Chilkat Imap.SshAuthenticatePw method, which authenticates the SSH tunnel using a username and password. The first argument is the SSH login name and the second is the SSH password. Call SshOpenTunnel first; after SSH authentication succeeds, connect and log in to IMAP.

Background: This is SSH authentication, which is entirely separate from the IMAP login that follows — the SSH credentials belong to the tunnel/jump host, while the IMAP credentials belong to the mail account. Password authentication is the simplest option; use SshAuthenticatePk for key-based authentication, which is generally preferred for automated jobs.

Chilkat React Native Downloads

Download Chilkat for React Native

React Native

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

async function chilkatExample() {
  // Demonstrates the Imap.SshAuthenticatePw method, which authenticates the SSH tunnel with a
  // username and password.  The 1st argument is the SSH login name and the 2nd is the SSH
  // password.  Call SshOpenTunnel first.

  const imap = new Imap();

  // Open the SSH tunnel first.
  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 = '';

  // Authenticate the SSH tunnel (this is SSH authentication, separate from IMAP login).
  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;
  }

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

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