Java

Share an Existing SSH Tunnel (Socket) with IMAP

Demonstrates the Chilkat Imap.UseSshTunnel method, which uses an existing SSH tunnel, represented by a Socket object, for IMAP connections. The only argument is the Socket. Call it before Connect. This example opens and authenticates the tunnel on a Socket, then routes IMAP through it.

Background: A Socket object can open and hold an SSH tunnel that several Chilkat objects share. This is the approach when the tunnel is managed independently of any one protocol object — for example a long-lived tunnel reused across IMAP, POP3, and SMTP sessions — whereas SshOpenTunnel ties the tunnel's lifetime to the Imap object.

Chilkat Java Downloads

Download Chilkat for Java

Chilkat2 Java

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

public class ChilkatExample {

    public static void main(String[] args) {
        // Demonstrates the Imap.UseSshTunnel method, which uses an existing SSH tunnel (represented by
        // a Socket) for IMAP connections.  The only argument is the Socket.  Call it before Connect.

        Imap imap = new Imap();

        // Open and authenticate an SSH tunnel on a Socket object.  This tunnel can be shared with
        // other Chilkat objects.
        Socket sshTunnel = new Socket();
        int sshPort = 22;
        try {
            sshTunnel.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 = "";

        try {
            sshTunnel.sshAuthenticatePw("sshUser", sshPassword);

            // Tell the Imap object to use the existing tunnel.
            imap.useSshTunnel(sshTunnel);

            // Now connect and log in to the IMAP server through the tunnel.
            imap.setSsl(true);
            imap.setPort(993);
            imap.connect("imap.example.com");

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

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