Ruby

Close the SSH Tunnel

Demonstrates the Chilkat MailMan.SshCloseTunnel method, which closes the SSH tunnel used for SMTP or POP3 communication. This example opens and authenticates a tunnel, performs a mail operation through it, and then closes it.

Background: An SSH tunnel holds an open connection to the SSH server for as long as it is needed, so closing it releases both that connection and the resources on the SSH server. The natural pattern is open → authenticate → do mail work → close. It is the counterpart to SshOpenTunnel, and is separate from closing the mail connections themselves (CloseSmtpConnection / Pop3EndSession), which ride inside the tunnel.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the MailMan.SshCloseTunnel method, which closes the SSH tunnel used for SMTP
#  or POP3 communication.

mailman = Chilkat::CkMailMan.new()

#  Configure the POP3 server connection.
mailman.put_MailHost("pop.example.com")
mailman.put_MailPort(995)
mailman.put_PopSsl(true)
mailman.put_PopUsername("user@example.com")
mailman.put_PopPassword("myPassword")

#  Open and authenticate the SSH tunnel.
success = mailman.SshOpenTunnel("ssh.example.com",22)
if (success == false)
    print mailman.lastErrorText() + "\n";
    exit
end

success = mailman.SshAuthenticatePw("sshUser","sshPassword")
if (success == false)
    print mailman.lastErrorText() + "\n";
    exit
end

#  ... perform mail operations through the tunnel ...
count = mailman.GetMailboxCount()
if (count < 0)
    print "Failed to get the mailbox count." + "\n";
else
    print "Mailbox count: " + count.to_s() + "\n";
end

#  Close the SSH tunnel when finished with it.
success = mailman.SshCloseTunnel()
if (success == false)
    print mailman.lastErrorText() + "\n";
    exit
end

print "SSH tunnel closed." + "\n";