Dart

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 Dart Downloads

Download Chilkat for Dart

Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // 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.

  final imap = CkImap();

  // Open the SSH tunnel first.
  final sshPort = 22;
  try {
    imap.sshOpenTunnel('ssh.example.com', sshPort);
  } on ChilkatException catch (e) {
    print(e.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.
  final sshPassword = '';

  // Authenticate the SSH tunnel (this is SSH authentication, separate from IMAP login).
  try {
    imap.sshAuthenticatePw('sshUser', sshPassword);
  } on ChilkatException catch (e) {
    print(e.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 {
    imap.connect('imap.example.com');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  try {
    imap.login('user@example.com', 'myPassword');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  try {
    imap.disconnect();
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  try {
    imap.sshCloseTunnel();
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }
}