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

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

# Indicate that STARTTLS should be used to convert
# to a secure TLS/SSL connection:
imap.put_StartTls(true)
imap.put_Port(143)

# Connect to an IMAP server and convert the connection
# to TLS/SSL via STARTTLS.
success = imap.Connect("imap.someMailServer.com")
if (success != true)
    print imap.lastErrorText() + "\n";
    exit
end

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

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