Unicode C

IMAP SSH Tunneling (Port Forwarding)

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

#include <C_CkImapW.h>
#include <C_CkEmailW.h>

void ChilkatSample(void)
    {
    BOOL success;
    HCkImapW imap;
    const wchar_t *sshHostname;
    int sshPort;
    int msgCount;
    int upperBound;
    HCkEmailW email;
    int i;
    BOOL bUid;

    success = FALSE;

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

    imap = CkImapW_Create();

    // 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 = L"www.mysshserver.com";
    sshPort = 22;

    // Connect to an SSH server and establish the SSH tunnel:
    success = CkImapW_SshOpenTunnel(imap,sshHostname,sshPort);
    if (success == FALSE) {
        wprintf(L"%s\n",CkImapW_lastErrorText(imap));
        CkImapW_Dispose(imap);
        return;
    }

    // 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 = CkImapW_SshAuthenticatePw(imap,L"mySshLogin",L"mySshPassword");
    if (success == FALSE) {
        wprintf(L"%s\n",CkImapW_lastErrorText(imap));
        CkImapW_Dispose(imap);
        return;
    }

    // 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.
    CkImapW_putSsl(imap,TRUE);
    CkImapW_putPort(imap,993);
    success = CkImapW_Connect(imap,L"imap.my-imap-server.com");
    if (success == FALSE) {
        wprintf(L"%s\n",CkImapW_lastErrorText(imap));
        CkImapW_Dispose(imap);
        return;
    }

    // Authenticate with the IMAP server via the SSH tunnel.
    success = CkImapW_Login(imap,L"myLogin",L"myPassword");
    if (success == FALSE) {
        wprintf(L"%s\n",CkImapW_lastErrorText(imap));
        CkImapW_Dispose(imap);
        return;
    }

    // Select an IMAP mailbox
    success = CkImapW_SelectMailbox(imap,L"Inbox");
    if (success == FALSE) {
        wprintf(L"%s\n",CkImapW_lastErrorText(imap));
        CkImapW_Dispose(imap);
        return;
    }

    // How many messages in Inbox?
    msgCount = CkImapW_getNumMessages(imap);
    if (msgCount == 0) {
        wprintf(L"No messages found.\n");
        CkImapW_Dispose(imap);
        return;
    }

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

    // Download up to the 1st 10 messages.
    email = CkEmailW_Create();

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

        success = CkImapW_FetchEmail(imap,FALSE,i,bUid,email);
        if (success == FALSE) {
            wprintf(L"%s\n",CkImapW_lastErrorText(imap));
            CkImapW_Dispose(imap);
            CkEmailW_Dispose(email);
            return;
        }

        wprintf(L"%s\n",CkEmailW_ck_from(email));
        wprintf(L"%s\n",CkEmailW_subject(email));
        wprintf(L"----\n");
    }

    // Disconnect from the IMAP server.
    // The SSH tunnel remains open.
    success = CkImapW_Disconnect(imap);
    if (success == FALSE) {
        wprintf(L"%s\n",CkImapW_lastErrorText(imap));
        CkImapW_Dispose(imap);
        CkEmailW_Dispose(email);
        return;
    }

    // It is possible to re-use the existing SSH tunnel for the next connection:
    success = CkImapW_Connect(imap,L"imap.my-imap-server2.com");
    if (success == FALSE) {
        wprintf(L"%s\n",CkImapW_lastErrorText(imap));
        CkImapW_Dispose(imap);
        CkEmailW_Dispose(email);
        return;
    }

    // Review the LastErrorText to see that the connection was made via the SSH tunnel:
    wprintf(L"%s\n",CkImapW_lastErrorText(imap));

    success = CkImapW_Disconnect(imap);
    if (success == FALSE) {
        wprintf(L"%s\n",CkImapW_lastErrorText(imap));
        CkImapW_Dispose(imap);
        CkEmailW_Dispose(email);
        return;
    }

    // Finally, close the SSH tunnel.
    success = CkImapW_SshCloseTunnel(imap);
    if (success == FALSE) {
        wprintf(L"%s\n",CkImapW_lastErrorText(imap));
        CkImapW_Dispose(imap);
        CkEmailW_Dispose(email);
        return;
    }

    wprintf(L"IMAP SSH tunneling example completed.\n");


    CkImapW_Dispose(imap);
    CkEmailW_Dispose(email);

    }