PHP

Authenticate an IMAP SSH Tunnel with a Password

Demonstrates the Chilkat Imap.SshAuthenticatePw method, which authenticates the SSH tunnel using a username and password. The first argument is the SSH login name and the second is the SSH password. Call SshOpenTunnel first; after SSH authentication succeeds, connect and log in to IMAP.

Background: This is SSH authentication, which is entirely separate from the IMAP login that follows — the SSH credentials belong to the tunnel/jump host, while the IMAP credentials belong to the mail account. Password authentication is the simplest option; use SshAuthenticatePk for key-based authentication, which is generally preferred for automated jobs.

Chilkat PHP Downloads

Download Chilkat for PHP

Chilkat2 PHP

<?php

use Chilkat2\Imap;

// Demonstrates the Imap.SshAuthenticatePw method, which authenticates the SSH tunnel with a
// username and password.  The 1st argument is the SSH login name and the 2nd is the SSH
// password.  Call SshOpenTunnel first.

$imap = new Imap();

// Open the SSH tunnel first.
$sshPort = 22;
try {
    $imap->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 = '';

    // Authenticate the SSH tunnel (this is SSH authentication, separate from IMAP login).
    $imap->SshAuthenticatePw('sshUser', $sshPassword);

    // With the SSH tunnel in place, connect and log in to the IMAP server as usual.  The IMAP
    // traffic flows through the tunnel automatically.
    $imap->Ssl = true;
    $imap->Port = 993;
    $imap->Connect('imap.example.com');

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

    $imap->Disconnect();

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