Perl Requires Chilkat v11.0.0+

IMAP SSH Tunneling (Port Forwarding)

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

use chilkat();

$success = 0;

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

$imap = chilkat::CkImap->new();

#  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:
$success = $imap->SshOpenTunnel($sshHostname,$sshPort);
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

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

#  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->put_Ssl(1);
$imap->put_Port(993);
$success = $imap->Connect("imap.my-imap-server.com");
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

#  Authenticate with the IMAP server via the SSH tunnel.
$success = $imap->Login("myLogin","myPassword");
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

#  Select an IMAP mailbox
$success = $imap->SelectMailbox("Inbox");
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

#  How many messages in Inbox?
$msgCount = $imap->get_NumMessages();
if ($msgCount == 0) {
    print "No messages found." . "\r\n";
    exit;
}

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

#  Download up to the 1st 10 messages.
$email = chilkat::CkEmail->new();

$bUid = 0;
for ($i = 1; $i <= $upperBound; $i++) {

    $success = $imap->FetchEmail(0,$i,$bUid,$email);
    if ($success == 0) {
        print $imap->lastErrorText() . "\r\n";
        exit;
    }

    print $email->ck_from() . "\r\n";
    print $email->subject() . "\r\n";
    print "----" . "\r\n";
}

#  Disconnect from the IMAP server.
#  The SSH tunnel remains open.
$success = $imap->Disconnect();
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

#  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) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

#  Review the LastErrorText to see that the connection was made via the SSH tunnel:
print $imap->lastErrorText() . "\r\n";

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

#  Finally, close the SSH tunnel.
$success = $imap->SshCloseTunnel();
if ($success == 0) {
    print $imap->lastErrorText() . "\r\n";
    exit;
}

print "IMAP SSH tunneling example completed." . "\r\n";