(Xojo Plugin) 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 Xojo Plugin Download Xojo Plugin for Windows, Linux, Mac OS X, and ARM, ARM64

Dim success As Boolean
success = False

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

Dim imap As New Chilkat.Imap

// To use a secure SSL connection, set SSL and the port:
imap.Ssl = True
// The typical port for IMAP SSL is 993
imap.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.)
Dim certStore As New Chilkat.CertStore
// The 1st argument is the filename, the 2nd arg is the 
// PFX file's password:
success = certStore.LoadPfxFile("myCertWithPrivateKey.pfx","secret")
If (success = False) Then
    System.DebugLog(certStore.LastErrorText)
    Return
End If

// Find the certificate by the subject common name:
Dim jsonCN As New Chilkat.JsonObject
success = jsonCN.UpdateString("CN","cert common name")

Dim cert As New Chilkat.Cert
success = certStore.FindCert(jsonCN,cert)
If (success = False) Then
    System.DebugLog(certStore.LastErrorText)
    Return
End If

// 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:
Dim cert2 As New Chilkat.Cert
// The 1st argument is the filename, the 2nd arg is the 
// PFX file's password:
success = cert2.LoadPfxFile("myClientCert.pfx","secret")
If (success = False) Then
    System.DebugLog(cert.LastErrorText)
    Return
End If

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

// Connect to an IMAP server.
success = imap.Connect("imap.example.com")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Login
success = imap.Login("myLogin","myPassword")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Select an IMAP mailbox
success = imap.SelectMailbox("Inbox")
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Get the message IDs of all the emails in the mailbox
Dim fetchUids As Boolean
fetchUids = True
Dim messageSet As New Chilkat.MessageSet
success = imap.QueryMbx("ALL",fetchUids,messageSet)
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Fetch the emails into a bundle object:
Dim bundle As New Chilkat.EmailBundle
Dim headersOnly As Boolean
headersOnly = False
success = imap.FetchMsgSet(headersOnly,messageSet,bundle)
If (success = False) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

// Loop over the bundle and display the FROM and SUBJECT of each.
Dim email As New Chilkat.Email
Dim i As Int32
i = 0
Dim numEmails As Int32
numEmails = bundle.MessageCount
While i < numEmails
    success = bundle.EmailAt(i,email)

    System.DebugLog(email.From)
    System.DebugLog(email.Subject)
    System.DebugLog("--")
    i = i + 1
Wend

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