Delphi ActiveX

IMAP Use Existing SSH Tunnel

Demonstrates how to connect to an IMAP server using an existing SSH tunnel. This creates a new channel within the SSH tunnel, which can be a TCP or TLS connection, and is connected to a remote IMAP server through port forwarding. Delphi ActiveX

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_TLB;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Integer;
tunnel: TChilkatSocket;
sshHostname: WideString;
sshPort: Integer;
imap: TChilkatImap;
msgCount: Integer;
upperBound: Integer;
email: TChilkatEmail;
i: Integer;
bUid: Integer;

begin
success := 0;

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

tunnel := TChilkatSocket.Create(Self);

sshHostname := 'sftp.example.com';
sshPort := 22;

// Connect to an SSH server and establish the SSH tunnel:
success := tunnel.SshOpenTunnel(sshHostname,sshPort);
if (success = 0) then
  begin
    Memo1.Lines.Add(tunnel.LastErrorText);
    Exit;
  end;

// Authenticate with the SSH server via a login/password
// or with a public key.  
// This example demonstrates SSH password authentication.
// Note: This is not authenticating with the IMAP server, it is
// for authenticating with the SSH server, which is separate.
success := tunnel.SshAuthenticatePw('mySshLogin','mySshPassword');
if (success = 0) then
  begin
    Memo1.Lines.Add(tunnel.LastErrorText);
    Exit;
  end;

// OK, the SSH tunnel is setup.  Now open a channel within the tunnel.
// Once the channel is obtained, the Socket API may
// be used exactly the same as usual, except all communications
// are sent through the channel in the SSH tunnel.
// Any number of channels may be created from the same SSH tunnel.
// Multiple channels may coexist at the same time.

imap := TChilkatImap.Create(Self);

// Let the IMAP object also use the SSH tunnel
success := imap.UseSshTunnel(tunnel.ControlInterface);
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

// Connect to an IMAP server via the already established SSH tunnel.
// Because the SSH tunnel has been previously setup,
// this does not establish a direct connection with the IMAP
// server.  It directs the SSH server to establish the connection.

// In this example, the IMAP server requires SSL/TLS.  The TLS connection
// will be enclosed within the SSH tunnel.
imap.Ssl := 1;
imap.Port := 993;
success := imap.Connect('imap.my-imap-server.com');
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

// Authenticate with the IMAP server via the SSH tunnel.
success := imap.Login('myLogin','myPassword');
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

// Select an IMAP mailbox
success := imap.SelectMailbox('Inbox');
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

// How many messages in Inbox?
msgCount := imap.NumMessages;
if (msgCount = 0) then
  begin
    Memo1.Lines.Add('No messages found.');
    Exit;
  end;

upperBound := 10;
if (msgCount < upperBound) then
  begin
    upperBound := msgCount;
  end;

// Download up to the 1st 10 messages.
email := TChilkatEmail.Create(Self);

bUid := 0;
for i := 1 to upperBound do
  begin

    success := imap.FetchEmail(0,i,bUid,email.ControlInterface);
    if (success = 0) then
      begin
        Memo1.Lines.Add(imap.LastErrorText);
        Exit;
      end;

    Memo1.Lines.Add(email.From);
    Memo1.Lines.Add(email.Subject);

  end;

// Disconnect from the IMAP server.
// The SSH tunnel remains open.
success := imap.Disconnect();
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

// It is possible to re-use the existing SSH tunnel for the next connection:
success := imap.Connect('imap.my-imap-server2.com');
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

// Review the LastErrorText to see that the connection was made via the SSH tunnel:
Memo1.Lines.Add(imap.LastErrorText);

// This closes the SSH channel, which is the connection with the IMAP server.
// It does not close the SSH tunnel
success := imap.Disconnect();
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

// Finally, close the SSH tunnel.

// Note: If other objects are using the same SSH tunnel, the tunnel is not 
// actually closed.  It is only closed when the last object using the tunnel closes it.

// At this point, both the imap and tunnel objects have references to the internal
// SSH tunnel.  We need to close each.

// This call doesn't actually close the tunnel yet, because the tunnel object still
// holds an internal reference.
success := imap.SshCloseTunnel();
if (success = 0) then
  begin
    Memo1.Lines.Add(imap.LastErrorText);
    Exit;
  end;

// This actually closes the SSH tunnel because it's the last object using it.
success := tunnel.SshCloseTunnel();
if (success = 0) then
  begin
    Memo1.Lines.Add(tunnel.LastErrorText);
    Exit;
  end;

Memo1.Lines.Add('IMAP pre-existing SSH tunnel example completed.');
end;