(Ruby) 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.

Chilkat Ruby Downloads install from rubygems.org gem install chilkat or download... Ruby Library for Windows, MacOS, Linux, Alpine Linux

require 'chilkat'

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

imap = Chilkat::CkImap.new()

# 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.new()
# The 1st argument is the filename, the 2nd arg is the 
# PFX file's password:
success = certStore.LoadPfxFile("myCertWithPrivateKey.pfx","secret")
if (success != true)
    print certStore.lastErrorText() + "\n";
    exit
end

# Find the certificate by the subject common name:

# cert is a CkCert
cert = certStore.FindCertBySubjectCN("Chilkat Software, Inc.")
if (certStore.get_LastMethodSuccess() == false)
    print certStore.lastErrorText() + "\n";
    exit
end

# 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.new()
# The 1st argument is the filename, the 2nd arg is the 
# PFX file's password:
success = cert2.LoadPfxFile("myClientCert.pfx","secret")
if (success != true)
    print cert.lastErrorText() + "\n";
    exit
end

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

# Connect to an IMAP server.
success = imap.Connect("imap.someMailServer.com")
if (success != true)
    print imap.lastErrorText() + "\n";
    exit
end

# Login
success = imap.Login("myLogin","myPassword")
if (success != true)
    print imap.lastErrorText() + "\n";
    exit
end

# Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
if (success != true)
    print imap.lastErrorText() + "\n";
    exit
end

# We can choose to fetch UIDs or sequence numbers.
fetchUids = true
# Get the message IDs of all the emails in the mailbox
# messageSet is a CkMessageSet
messageSet = imap.Search("ALL",fetchUids)
if (imap.get_LastMethodSuccess() == false)
    print imap.lastErrorText() + "\n";
    exit
end

# Fetch the emails into a bundle object:

# bundle is a CkEmailBundle
bundle = imap.FetchBundle(messageSet)
if (imap.get_LastMethodSuccess() == false)

    print imap.lastErrorText() + "\n";
    exit
end

# Loop over the bundle and display the FROM and SUBJECT of each.
i = 0
numEmails = bundle.get_MessageCount()
while i < numEmails
    # email is a CkEmail
    email = bundle.GetEmail(i)
    print email.ck_from() + "\n";
    print email.subject() + "\n";
    print "--" + "\n";

    i = i + 1
end

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