AutoIt

Authenticate an IMAP SSH Tunnel with a Password

Demonstrates the Chilkat Imap.SshAuthenticatePw method, which authenticates the SSH tunnel using a username and password. The first argument is the SSH login name and the second is the SSH password. Call SshOpenTunnel first; after SSH authentication succeeds, connect and log in to IMAP.

Background: This is SSH authentication, which is entirely separate from the IMAP login that follows — the SSH credentials belong to the tunnel/jump host, while the IMAP credentials belong to the mail account. Password authentication is the simplest option; use SshAuthenticatePk for key-based authentication, which is generally preferred for automated jobs.

Chilkat AutoIt Downloads

Download Chilkat for AutoIt

AutoIt

Local $bSuccess = False

;  Demonstrates the Imap.SshAuthenticatePw method, which authenticates the SSH tunnel with a
;  username and password.  The 1st argument is the SSH login name and the 2nd is the SSH
;  password.  Call SshOpenTunnel first.

$oImap = ObjCreate("Chilkat.Imap")

;  Open the SSH tunnel first.
Local $iSshPort = 22
$bSuccess = $oImap.SshOpenTunnel("ssh.example.com",$iSshPort)
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf

;  The SSH password is not hard-coded in source.  Insert code here to obtain it from an
;  interactive prompt, environment variable, or a secrets vault.
Local $sshPassword

;  Authenticate the SSH tunnel (this is SSH authentication, separate from IMAP login).
$bSuccess = $oImap.SshAuthenticatePw("sshUser",$sshPassword)
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf

;  With the SSH tunnel in place, connect and log in to the IMAP server as usual.  The IMAP
;  traffic flows through the tunnel automatically.
$oImap.Ssl = True
$oImap.Port = 993
$bSuccess = $oImap.Connect("imap.example.com")
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oImap.Login("user@example.com","myPassword")
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oImap.Disconnect()
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf

$bSuccess = $oImap.SshCloseTunnel()
If ($bSuccess = False) Then
    ConsoleWrite($oImap.LastErrorText & @CRLF)
    Exit
EndIf