Sample code for 30+ languages & platforms
Dart

Share an Existing SSH Tunnel (Socket) with IMAP

See more IMAP Examples

Demonstrates the Chilkat Imap.UseSshTunnel method, which uses an existing SSH tunnel, represented by a Socket object, for IMAP connections. The only argument is the Socket. Call it before Connect. This example opens and authenticates the tunnel on a Socket, then routes IMAP through it.

Background: A Socket object can open and hold an SSH tunnel that several Chilkat objects share. This is the approach when the tunnel is managed independently of any one protocol object — for example a long-lived tunnel reused across IMAP, POP3, and SMTP sessions — whereas SshOpenTunnel ties the tunnel's lifetime to the Imap object.

Chilkat Dart Downloads

Dart
import 'package:chilkat/chilkat.dart';

void main() {
  // Demonstrates the Imap.UseSshTunnel method, which uses an existing SSH tunnel (represented by
  // a Socket) for IMAP connections.  The only argument is the Socket.  Call it before Connect.

  final imap = CkImap();

  // Open and authenticate an SSH tunnel on a Socket object.  This tunnel can be shared with
  // other Chilkat objects.
  final sshTunnel = CkSocket();
  final sshPort = 22;
  try {
    sshTunnel.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 = '';

  try {
    sshTunnel.sshAuthenticatePw('sshUser', sshPassword);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Tell the Imap object to use the existing tunnel.
  try {
    imap.useSshTunnel(sshTunnel);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Now connect and log in to the IMAP server through the tunnel.
  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;
  }
}