IMAP SSH Tunneling (Port Forwarding)

Demonstrates how to setup an SSH tunnel for IMAP.

Download Chilkat Ruby Library

require 'chilkat'

imap = Chilkat::CkImap.new()

#  Anything unlocks the component and begins a fully-functional 30-day trial.
success = imap.UnlockComponent("Anything for 30-day trial")
if (success != true)
    print imap.lastErrorText() + "\n"
    exit
end

#  Connect to an SSH server and establish the SSH tunnel:

#  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 = "www.mysshserver.com"
sshPort = 22
success = imap.SshTunnel(sshHostname,sshPort)
if (success != true)
    print imap.lastErrorText() + "\n"
    exit
end

#  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("mySshLogin","mySshPassword")
if (success != true)
    print imap.lastErrorText() + "\n"
    exit
end

#  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.
success = imap.Connect("mail.chilkatsoft.com")
if (success != true)
    print imap.lastErrorText() + "\n"
    exit
end

#  Authenticate with the IMAP server via the SSH tunnel.
success = imap.Login("myLogin","myPassword")
if (success != true)
    print imap.lastErrorText() + "\n"
    exit
end

#  Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
if (success != true)
    print imap.lastErrorText() + "\n"
    exit
end

#  We can choose to fetch UIDs or sequence numbers.
fetchUids = true
#  Get the message IDs of all the emails in the mailbox
# messageSet is a CkMessageSet
messageSet = imap.Search("ALL",fetchUids)
if (messageSet == nil )
    print imap.lastErrorText() + "\n"
    exit
end

#  Fetch the emails into a bundle object:

# bundle is a CkEmailBundle
bundle = imap.FetchBundle(messageSet)
if (bundle == nil )

    print imap.lastErrorText() + "\n"
    exit
end

#  Loop over the bundle and display the FROM and SUBJECT of each.

for i in 0 .. bundle.get_MessageCount() - 1

    # email is a CkEmail
    email = bundle.GetEmail(i)
    print email.ck_from() + "\n";
    print email.subject() + "\n";
    print "--" + "\n";

end

#  Disconnect from the IMAP server.
imap.Disconnect()