PHP

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

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Imap;
use Chilkat2\Socket;

// 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 = new Imap();

// Open and authenticate an SSH tunnel on a Socket object.  This tunnel can be shared with
// other Chilkat objects.
$sshTunnel = new Socket();
$sshPort = 22;
try {
    $sshTunnel->SshOpenTunnel('ssh.example.com', $sshPort);

    // 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.
    $sshPassword = '';

    $sshTunnel->SshAuthenticatePw('sshUser', $sshPassword);

    // Tell the Imap object to use the existing tunnel.
    $imap->UseSshTunnel($sshTunnel);

    // Now connect and log in to the IMAP server through the tunnel.
    $imap->Ssl = true;
    $imap->Port = 993;
    $imap->Connect('imap.example.com');

    $imap->Login('user@example.com', 'myPassword');

    $imap->Disconnect();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}