CkPython

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. CkPython

import sys
import chilkat

success = False

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

imap = chilkat.CkImap()

# To use a secure SSL connection, set SSL and the port:
imap.put_Ssl(True)
# The typical port for IMAP SSL is 993
imap.put_Port(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.)
certStore = chilkat.CkCertStore()
# The 1st argument is the filename, the 2nd arg is the 
# PFX file's password:
success = certStore.LoadPfxFile("myCertWithPrivateKey.pfx","secret")
if (success == False):
    print(certStore.lastErrorText())
    sys.exit()

# Find the certificate by the subject common name:
jsonCN = chilkat.CkJsonObject()
jsonCN.UpdateString("CN","cert common name")

cert = chilkat.CkCert()
success = certStore.FindCert(jsonCN,cert)
if (success == False):
    print(certStore.lastErrorText())
    sys.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:
cert2 = chilkat.CkCert()
# The 1st argument is the filename, the 2nd arg is the 
# PFX file's password:
success = cert2.LoadPfxFile("myClientCert.pfx","secret")
if (success == False):
    print(cert.lastErrorText())
    sys.exit()

# Use the cert:
success = imap.SetSslClientCert(cert)

# Connect to an IMAP server.
success = imap.Connect("imap.example.com")
if (success == False):
    print(imap.lastErrorText())
    sys.exit()

# Login
success = imap.Login("myLogin","myPassword")
if (success == False):
    print(imap.lastErrorText())
    sys.exit()

# Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
if (success == False):
    print(imap.lastErrorText())
    sys.exit()

# Get the message IDs of all the emails in the mailbox
fetchUids = True
messageSet = chilkat.CkMessageSet()
success = imap.QueryMbx("ALL",fetchUids,messageSet)
if (success == False):
    print(imap.lastErrorText())
    sys.exit()

# Fetch the emails into a bundle object:
bundle = chilkat.CkEmailBundle()
headersOnly = False
success = imap.FetchMsgSet(headersOnly,messageSet,bundle)
if (success == False):
    print(imap.lastErrorText())
    sys.exit()

# Loop over the bundle and display the FROM and SUBJECT of each.
email = chilkat.CkEmail()
i = 0
numEmails = bundle.get_MessageCount()
while i < numEmails :
    bundle.EmailAt(i,email)

    print(email.ck_from())
    print(email.subject())
    print("--")
    i = i + 1

# Disconnect from the IMAP server.
success = imap.Disconnect()