PowerShell

Set a TLS Client Certificate for IMAP

Demonstrates the Chilkat Imap.SetSslClientCert method, which supplies a client certificate for TLS client-certificate authentication. The only argument is a Cert object that must provide access to its private key. Call it before connecting. This example loads the certificate from a PFX file.

Note: The certificate path is relative to the application's current working directory. Supply the path to your own certificate file.

Background: Most IMAP servers authenticate with a username and password only. A few high-security deployments additionally require mutual TLS, where the client presents its own certificate during the handshake. Because that happens as part of connecting, the certificate must be set before Connect — setting it afterward has no effect on the already-established connection.

Chilkat PowerShell Downloads

Download Chilkat for PowerShell

PowerShell

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

$success = $false

#  Demonstrates the Imap.SetSslClientCert method, which supplies a client certificate for TLS
#  client-certificate authentication.  The only argument is a Cert object.  It must be called
#  before connecting.

$imap = New-Object Chilkat.Imap

$imap.Ssl = $true
$imap.Port = 993

#  The PFX password is not hard-coded in source.  Insert code here to obtain it from an
#  interactive prompt, environment variable, or a secrets vault.

#  Load the client certificate (and its private key) from a PFX file.
$cert = New-Object Chilkat.Cert
$success = $cert.LoadPfxFile("qa_data/client.pfx",$pfxPassword)
if ($success -eq $false) {
    $($cert.LastErrorText)
    exit
}

#  Provide the client certificate BEFORE connecting.
$success = $imap.SetSslClientCert($cert)
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

$success = $imap.Connect("imap.example.com")
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

$success = $imap.Login("user@example.com","myPassword")
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}

$success = $imap.Disconnect()
if ($success -eq $false) {
    $($imap.LastErrorText)
    exit
}