JavaScript

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

var success = false;

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

var imap = new CkImap();

// 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.)
var certStore = new 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) {
    console.log(certStore.LastErrorText);
    return;
}

// Find the certificate by the subject common name:
var jsonCN = new CkJsonObject();
jsonCN.UpdateString("CN","cert common name");

var cert = new CkCert();
success = certStore.FindCert(jsonCN,cert);
if (success == false) {
    console.log(certStore.LastErrorText);
    return;
}

// 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:
var cert2 = new 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) {
    console.log(cert.LastErrorText);
    return;
}

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

// Connect to an IMAP server.
success = imap.Connect("imap.example.com");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

// Login
success = imap.Login("myLogin","myPassword");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

// Select an IMAP mailbox
success = imap.SelectMailbox("Inbox");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

// Get the message IDs of all the emails in the mailbox
var fetchUids = true;
var messageSet = new CkMessageSet();
success = imap.QueryMbx("ALL",fetchUids,messageSet);
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

// Fetch the emails into a bundle object:
var bundle = new CkEmailBundle();
var headersOnly = false;
success = imap.FetchMsgSet(headersOnly,messageSet,bundle);
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

// Loop over the bundle and display the FROM and SUBJECT of each.
var email = new CkEmail();
var i = 0;
var numEmails = bundle.MessageCount;
while (i < numEmails) {
    bundle.EmailAt(i,email);

    console.log(email.From);
    console.log(email.Subject);
    console.log("--");
    i = i+1;
}

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