Delphi DLL

Share an Existing SSH Tunnel (Socket) with IMAP

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 Delphi DLL Downloads

Download Chilkat for Delphi DLL

Delphi DLL

var
success: Boolean;
imap: HCkImap;
sshTunnel: HCkSocket;
sshPort: Integer;
sshPassword: PWideChar;

begin
success := False;

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

imap := CkImap_Create();

//  Open and authenticate an SSH tunnel on a Socket object.  This tunnel can be shared with
//  other Chilkat objects.
sshTunnel := CkSocket_Create();
sshPort := 22;
success := CkSocket_SshOpenTunnel(sshTunnel,'ssh.example.com',sshPort);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSocket__lastErrorText(sshTunnel));
    Exit;
  end;

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

success := CkSocket_SshAuthenticatePw(sshTunnel,'sshUser',sshPassword);
if (success = False) then
  begin
    Memo1.Lines.Add(CkSocket__lastErrorText(sshTunnel));
    Exit;
  end;

//  Tell the Imap object to use the existing tunnel.
success := CkImap_UseSshTunnel(imap,sshTunnel);
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

//  Now connect and log in to the IMAP server through the tunnel.
CkImap_putSsl(imap,True);
CkImap_putPort(imap,993);
success := CkImap_Connect(imap,'imap.example.com');
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;
success := CkImap_Login(imap,'user@example.com','myPassword');
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

success := CkImap_Disconnect(imap);
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

CkImap_Dispose(imap);
CkSocket_Dispose(sshTunnel);