(Xojo Plugin) 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.

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

// 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) Then
    System.DebugLog(imap.LastErrorText)
    Return
End If

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

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