Ruby

Connect to an IMAP Server

Demonstrates the Chilkat Imap.Connect method, which establishes a TCP connection to the IMAP server but does not authenticate. The argument may be a hostname, IPv4, or IPv6 address; configure Ssl and Port first. This example connects with implicit TLS, then logs in and disconnects.

Background: IMAP (Internet Message Access Protocol) is the protocol for accessing mail that stays on the server — unlike POP3, which typically downloads and removes it. That server-side model is what lets multiple devices see the same mailboxes, folders, and read/unread state. A session starts by connecting (usually implicit TLS on port 993), then authenticating — Connect performs only the first step, so it is always followed by Login.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Imap.Connect method, which establishes a TCP connection to the IMAP
#  server but does not authenticate.  Call Login after connecting to authenticate.

imap = Chilkat::CkImap.new()

#  Use implicit TLS on the standard IMAPS port.
imap.put_Ssl(true)
imap.put_Port(993)

#  Establish the connection to the IMAP server (no authentication yet).
success = imap.Connect("imap.example.com")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

print "Connected to the IMAP server." + "\n";

#  Authenticate the session.
success = imap.Login("user@example.com","myPassword")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

#  Disconnect when finished.
success = imap.Disconnect()
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end