Java

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

Download Chilkat for Java

Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Imap;

public class ChilkatExample {

    public static void main(String[] args) {
        // 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 imap = new Imap();

        // Open the SSH tunnel first.
        int sshPort = 22;
        try {
            imap.sshOpenTunnel("ssh.example.com", sshPort);
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // 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.
        String sshPassword = "";

        // Authenticate the SSH tunnel (this is SSH authentication, separate from IMAP login).
        try {
            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.setSsl(true);
            imap.setPort(993);
            imap.connect("imap.example.com");

            imap.login("user@example.com", "myPassword");

            imap.disconnect();

            imap.sshCloseTunnel();
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }
    }
}