Ruby

Explicitly Begin a POP3 Session

Demonstrates the Chilkat MailMan.Pop3BeginSession method, which explicitly begins a POP3 session by connecting to the POP3 server and authenticating using the current POP3 property settings. Calling it is optional. This example begins a session, performs a mailbox operation, and ends the session.

Background: Pop3BeginSession combines connecting and authenticating into one call. Chilkat does this automatically when a mailbox operation needs it, so the value of calling it explicitly is control: you open one session, perform several operations against it, and close it with Pop3EndSession — avoiding repeated connect/authenticate round trips and keeping deletion marks within a single, well-defined session.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the MailMan.Pop3BeginSession method, which explicitly begins a POP3 session
#  by connecting to the POP3 server and authenticating using the current POP3 property
#  settings.

mailman = Chilkat::CkMailMan.new()

#  Configure the POP3 server connection.
mailman.put_MailHost("pop.example.com")
mailman.put_MailPort(995)
mailman.put_PopSsl(true)
mailman.put_PopUsername("user@example.com")
mailman.put_PopPassword("myPassword")

#  Explicitly begin the POP3 session (connect + authenticate).

success = mailman.Pop3BeginSession()
if (success == false)
    print mailman.lastErrorText() + "\n";
    exit
end

#  Perform one or more mailbox operations within this single session.
print "Mailbox count: " + mailman.GetMailboxCount().to_s() + "\n";

#  End the session when finished.
success = mailman.Pop3EndSession()
if (success == false)
    print mailman.lastErrorText() + "\n";
    exit
end

print "POP3 session completed." + "\n";