Swift

IMAP SSH Tunneling (Port Forwarding)

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

func chilkatTest() {
    var success: Bool = false

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

    let imap = CkoImap()!

    // 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).
    var sshHostname: String? = "www.mysshserver.com"
    var sshPort: Int = 22

    // Connect to an SSH server and establish the SSH tunnel:
    success = imap.sshOpenTunnel(sshHostname: sshHostname, sshPort: sshPort)
    if success == false {
        print("\(imap.lastErrorText!)")
        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 = imap.sshAuthenticatePw(sshLogin: "mySshLogin", sshPassword: "mySshPassword")
    if success == false {
        print("\(imap.lastErrorText!)")
        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.
    imap.ssl = true
    imap.port = 993
    success = imap.connect(hostname: "imap.my-imap-server.com")
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }

    // Authenticate with the IMAP server via the SSH tunnel.
    success = imap.login(login: "myLogin", password: "myPassword")
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }

    // Select an IMAP mailbox
    success = imap.selectMailbox(mailbox: "Inbox")
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }

    // How many messages in Inbox?
    var msgCount: Int = imap.numMessages.intValue
    if msgCount == 0 {
        print("No messages found.")
        return
    }

    var upperBound: Int = 10
    if msgCount < upperBound {
        upperBound = msgCount
    }

    // Download up to the 1st 10 messages.
    let email = CkoEmail()!
    var i: Int
    var bUid: Bool = false
    for i = 1; i <= upperBound; i++ {

        success = imap.fetchEmail(headerOnly: false, msgId: i, bUid: bUid, email: email)
        if success == false {
            print("\(imap.lastErrorText!)")
            return
        }

        print("\(email.from!)")
        print("\(email.subject!)")
        print("----")
    }

    // Disconnect from the IMAP server.
    // The SSH tunnel remains open.
    success = imap.disconnect()
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }

    // It is possible to re-use the existing SSH tunnel for the next connection:
    success = imap.connect(hostname: "imap.my-imap-server2.com")
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }

    // Review the LastErrorText to see that the connection was made via the SSH tunnel:
    print("\(imap.lastErrorText!)")

    success = imap.disconnect()
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }

    // Finally, close the SSH tunnel.
    success = imap.sshCloseTunnel()
    if success == false {
        print("\(imap.lastErrorText!)")
        return
    }

    print("IMAP SSH tunneling example completed.")

}