PHP Requires Chilkat v11.0.0+

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. Chilkat2 PHP

<?php

use Chilkat2\Email;
use Chilkat2\Imap;
use Chilkat2\Socket;

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

$tunnel = new Socket();

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

// Connect to an SSH server and establish the SSH tunnel:
try {
    $tunnel->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.
    $tunnel->SshAuthenticatePw('mySshLogin', 'mySshPassword');

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

    // Let the IMAP object also use the SSH tunnel
    $imap->UseSshTunnel($tunnel);

    // 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 = 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";
}

// 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";

// This closes the SSH channel, which is the connection with the IMAP server.
// It does not close the SSH tunnel
try {
    $imap->Disconnect();

    // 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.
    $imap->SshCloseTunnel();

    // This actually closes the SSH tunnel because it's the last object using it.
    $tunnel->SshCloseTunnel();
} catch (\Chilkat2\Exception $e) {
    echo $e->getMessage(), "\n";
    exit;
}

echo "IMAP pre-existing SSH tunnel example completed.\n";