(PowerShell) IMAP SSH Tunneling (Port Forwarding)

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

Chilkat .NET Downloads Chilkat .NET Assemblies

Add-Type -Path "C:\chilkat\ChilkatDotNet47-9.5.0-x64\ChilkatDotNet47.dll"

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

$imap = New-Object Chilkat.Imap

# 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

# Connect to an SSH server and establish the SSH tunnel:
$success = $imap.SshOpenTunnel($sshHostname,$sshPort)
if ($success -ne $true) {
    $($imap.LastErrorText)
    exit
}

# 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 -ne $true) {
    $($imap.LastErrorText)
    exit
}

# 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("imap.my-imap-server.com")
if ($success -ne $true) {
    $($imap.LastErrorText)
    exit
}

# Authenticate with the IMAP server via the SSH tunnel.
$success = $imap.Login("myLogin","myPassword")
if ($success -ne $true) {
    $($imap.LastErrorText)
    exit
}

# Select an IMAP mailbox
$success = $imap.SelectMailbox("Inbox")
if ($success -ne $true) {
    $($imap.LastErrorText)
    exit
}

# How many messages in Inbox?
$msgCount = $imap.NumMessages
if ($msgCount -eq 0) {
    $("No messages found.")
    exit
}

$upperBound = 10
if ($msgCount -lt $upperBound) {
    $upperBound = $msgCount
}

# Download up to the 1st 10 messages.

$bUid = $false
for ($i = 1; $i -le $upperBound; $i++) {

    $email = $imap.FetchSingle($i,$bUid)
    if ($imap.LastMethodSuccess -eq $false) {
        $($imap.LastErrorText)
        exit

    }
    else {
        $($email.From)
        $($email.Subject)
        $("----")

    }

}

# Disconnect from the IMAP server.
# The SSH tunnel remains open.
$success = $imap.Disconnect()
if ($success -ne $true) {
    $($imap.LastErrorText)
    exit
}

# It is possible to re-use the existing SSH tunnel for the next connection:
$success = $imap.Connect("imap.my-imap-server2.com")
if ($success -ne $true) {
    $($imap.LastErrorText)
    exit
}

# Review the LastErrorText to see that the connection was made via the SSH tunnel:
$($imap.LastErrorText)

$success = $imap.Disconnect()
if ($success -ne $true) {
    $($imap.LastErrorText)
    exit
}

# Finally, close the SSH tunnel.
$success = $imap.SshCloseTunnel()
if ($success -ne $true) {
    $($imap.LastErrorText)
    exit
}

$("IMAP SSH tunneling example completed.")