JavaScript

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.

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

JavaScript

var success = false;

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

var mailman = new CkMailMan();

//  Configure the POP3 server connection.
mailman.MailHost = "pop.example.com";
mailman.MailPort = 995;
mailman.PopSsl = true;
mailman.PopUsername = "user@example.com";
mailman.PopPassword = "myPassword";

//  Open and authenticate the SSH tunnel.
success = mailman.SshOpenTunnel("ssh.example.com",22);
if (success == false) {
    console.log(mailman.LastErrorText);
    return;
}

success = mailman.SshAuthenticatePw("sshUser","sshPassword");
if (success == false) {
    console.log(mailman.LastErrorText);
    return;
}

//  ... perform mail operations through the tunnel ...
var count = mailman.GetMailboxCount();
if (count < 0) {
    console.log("Failed to get the mailbox count.");
}
else {
    console.log("Mailbox count: " + count);
}

//  Close the SSH tunnel when finished with it.
success = mailman.SshCloseTunnel();
if (success == false) {
    console.log(mailman.LastErrorText);
    return;
}

console.log("SSH tunnel closed.");