(JavaScript) IMAP STARTTLS (Explicit TLS/SSL)

The StartTls property is set to force the Connect method to automatically convert an connection to TLS/SSL via the STARTTLS IMAP command.

This is also known as "explicit TLS/SSL" as opposed to "implicit TLS/SSL". With implicit TLS/SSL, the IMAP client connects on the well-known IMAP TLS/SSL port 993 and the secure channel is immediately established. With explicit TLS/SSL, the IMAP client connects on the typical non-secure port (143 usually) and the converts the connection via the STARTTLS command.

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

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

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();

// Indicate that STARTTLS should be used to convert
// to a secure TLS/SSL connection:
imap.StartTls = true;
imap.Port = 143;

// Connect to an IMAP server and convert the connection
// to TLS/SSL via STARTTLS.
success = imap.Connect("imap.example.com");
if (success == false) {
    console.log(imap.LastErrorText);
    return;
}

// The remainder of this example is the same as for 
// non-TLS/SSL...

// 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();