(Tcl) Using Client Certificate w/ IMAP SSL

Demonstrates how to use a client-side certificate with an IMAP SSL connection. The SetSslClientCert method is called to specify a certificate to be used for the SSL connection.

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

set success 0

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

set imap [new_CkImap]

# To use a secure SSL connection, set SSL and the port:
CkImap_put_Ssl $imap 1
# The typical port for IMAP SSL is 993
CkImap_put_Port $imap 993

# Load a certificate from a PFX file and use it.
# Note: Other methods are available to load pre-installed
# certificates from registry-based certificate stores.

# Create an instance of a certificate store object, load a PFX file,
# locate the certificate we need, and use it for signing.
# (a PFX file may contain more than one certificate.)
set certStore [new_CkCertStore]

# The 1st argument is the filename, the 2nd arg is the 
# PFX file's password:
set success [CkCertStore_LoadPfxFile $certStore "myCertWithPrivateKey.pfx" "secret"]
if {$success == 0} then {
    puts [CkCertStore_lastErrorText $certStore]
    delete_CkImap $imap
    delete_CkCertStore $certStore
    exit
}

# Find the certificate by the subject common name:
set jsonCN [new_CkJsonObject]

CkJsonObject_UpdateString $jsonCN "CN" "cert common name"

set cert [new_CkCert]

set success [CkCertStore_FindCert $certStore $jsonCN $cert]
if {$success == 0} then {
    puts [CkCertStore_lastErrorText $certStore]
    delete_CkImap $imap
    delete_CkCertStore $certStore
    delete_CkJsonObject $jsonCN
    delete_CkCert $cert
    exit
}

# If a PFX file is known to contain a single certificate,
# you may load it directly into a Chilkat certificate object.
# This snippet of source code shows how:
set cert2 [new_CkCert]

# The 1st argument is the filename, the 2nd arg is the 
# PFX file's password:
set success [CkCert_LoadPfxFile $cert2 "myClientCert.pfx" "secret"]
if {$success == 0} then {
    puts [CkCert_lastErrorText $cert]
    delete_CkImap $imap
    delete_CkCertStore $certStore
    delete_CkJsonObject $jsonCN
    delete_CkCert $cert
    delete_CkCert $cert2
    exit
}

# Use the cert:
set success [CkImap_SetSslClientCert $imap $cert]

# Connect to an IMAP server.
set success [CkImap_Connect $imap "imap.example.com"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkCertStore $certStore
    delete_CkJsonObject $jsonCN
    delete_CkCert $cert
    delete_CkCert $cert2
    exit
}

# Login
set success [CkImap_Login $imap "myLogin" "myPassword"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkCertStore $certStore
    delete_CkJsonObject $jsonCN
    delete_CkCert $cert
    delete_CkCert $cert2
    exit
}

# Select an IMAP mailbox
set success [CkImap_SelectMailbox $imap "Inbox"]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkCertStore $certStore
    delete_CkJsonObject $jsonCN
    delete_CkCert $cert
    delete_CkCert $cert2
    exit
}

# Get the message IDs of all the emails in the mailbox
set fetchUids 1
set messageSet [new_CkMessageSet]

set success [CkImap_QueryMbx $imap "ALL" $fetchUids $messageSet]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkCertStore $certStore
    delete_CkJsonObject $jsonCN
    delete_CkCert $cert
    delete_CkCert $cert2
    delete_CkMessageSet $messageSet
    exit
}

# Fetch the emails into a bundle object:
set bundle [new_CkEmailBundle]

set headersOnly 0
set success [CkImap_FetchMsgSet $imap $headersOnly $messageSet $bundle]
if {$success == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkImap $imap
    delete_CkCertStore $certStore
    delete_CkJsonObject $jsonCN
    delete_CkCert $cert
    delete_CkCert $cert2
    delete_CkMessageSet $messageSet
    delete_CkEmailBundle $bundle
    exit
}

# Loop over the bundle and display the FROM and SUBJECT of each.
set email [new_CkEmail]

set i 0
set numEmails [CkEmailBundle_get_MessageCount $bundle]
while {$i < $numEmails} {
    CkEmailBundle_EmailAt $bundle $i $email

    puts [CkEmail_from $email]
    puts [CkEmail_subject $email]
    puts "--"
    set i [expr $i + 1]
}

# Disconnect from the IMAP server.
set success [CkImap_Disconnect $imap]

delete_CkImap $imap
delete_CkCertStore $certStore
delete_CkJsonObject $jsonCN
delete_CkCert $cert
delete_CkCert $cert2
delete_CkMessageSet $messageSet
delete_CkEmailBundle $bundle
delete_CkEmail $email