Sample code for 30+ languages & platforms
Perl

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

Perl
use chilkat();

$success = 0;

#  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 = chilkat::CkImap->new();

#  Open and authenticate an SSH tunnel on a Socket object.  This tunnel can be shared with
#  other Chilkat objects.
$sshTunnel = chilkat::CkSocket->new();
$sshPort = 22;
$success = $sshTunnel->SshOpenTunnel("ssh.example.com",$sshPort);
if ($success == 0) {
    print $sshTunnel->lastErrorText() . "\r\n";
    exit;
}

#  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 = $sshTunnel->SshAuthenticatePw("sshUser",$sshPassword);
if ($success == 0) {
    print $sshTunnel->lastErrorText() . "\r\n";
    exit;
}

#  Tell the Imap object to use the existing tunnel.
$success = $imap->UseSshTunnel($sshTunnel);
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

#  Now connect and log in to the IMAP server through the tunnel.
$imap->put_Ssl(1);
$imap->put_Port(993);
$success = $imap->Connect("imap.example.com");
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

$success = $imap->Login('user@example.com',"myPassword");
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

$success = $imap->Disconnect();
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}