PHP Requires Chilkat v11.0.0+

IMAP SSH Tunneling (Port Forwarding)

Demonstrates how to setup and use an SSH tunnel for IMAP. Chilkat2 PHP

<?php

use Chilkat2\Email;
use Chilkat2\Imap;

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

$imap = new Imap();

// The SSH hostname may be a hostname or an
// IP address, such as "192.168.1.108".
// The port is typically 22 (the standard port for SSH).
$sshHostname = 'www.mysshserver.com';
$sshPort = 22;

// Connect to an SSH server and establish the SSH tunnel:
try {
    $imap->SshOpenTunnel($sshHostname, $sshPort);

    // 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.
    $imap->SshAuthenticatePw('mySshLogin', 'mySshPassword');

    // OK, the SSH tunnel is setup.  The IMAP component may
    // be used exactly the same as usual, except all communications
    // are sent through the SSH tunnel.

    // Connect to an IMAP server via the 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 = true;
    $imap->Port = 993;
    $imap->Connect('imap.my-imap-server.com');

    // Authenticate with the IMAP server via the SSH tunnel.
    $imap->Login('myLogin', 'myPassword');

    // Select an IMAP mailbox
    $imap->SelectMailbox('Inbox');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// How many messages in Inbox?
$msgCount = $imap->NumMessages;
if ($msgCount == 0) {
    echo "No messages found.\n";
    exit;
}

$upperBound = 10;
if ($msgCount < $upperBound) {
    $upperBound = $msgCount;
}

// Download up to the 1st 10 messages.
$email = new Email();
$bUid = false;
for ($i = 1; $i <= $upperBound; $i++) {
    try {
        $imap->FetchEmail(false, $i, $bUid, $email);
    } catch (\Chilkat2\Exception $e) {
        echo $e->getMessage(), "\n";
        exit;
    }

    echo $email->From, "\n";
    echo $email->Subject, "\n";
    echo "----\n";
}

// Disconnect from the IMAP server.
// The SSH tunnel remains open.
try {
    $imap->Disconnect();

    // It is possible to re-use the existing SSH tunnel for the next connection:
    $imap->Connect('imap.my-imap-server2.com');
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

// Review the LastErrorText to see that the connection was made via the SSH tunnel:
echo $imap->LastErrorText, "\n";

try {
    $imap->Disconnect();

    // Finally, close the SSH tunnel.
    $imap->SshCloseTunnel();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo "IMAP SSH tunneling example completed.\n";