Ruby

Clear the IMAP Session Log

Demonstrates the Chilkat Imap.ClearSessionLog method, which clears the in-memory text returned by the SessionLog property. Session logging remains enabled or disabled according to the KeepSessionLog property. This example connects, logs in, and clears the log.

Background: When session logging is enabled, the SessionLog accumulates the raw IMAP command/response dialog — the first thing to inspect when diagnosing a failure. Over a long-lived session that log grows continuously; ClearSessionLog resets it so you can capture just the exchange for the next operation of interest, rather than sifting through the entire history.

Chilkat Ruby Downloads

Download Chilkat for Ruby

Ruby

require 'chilkat'

success = false

#  Demonstrates the Imap.ClearSessionLog method, which clears the in-memory text returned by
#  the SessionLog property.  Session logging remains enabled or disabled according to the
#  KeepSessionLog property.

imap = Chilkat::CkImap.new()

imap.put_Ssl(true)
imap.put_Port(993)

success = imap.Connect("imap.example.com")
if (success == false)
    print imap.lastErrorText() + "\n";
    exit
end

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

#  Clear the session log (for example, before the next operation you want to capture).
imap.ClearSessionLog()

print "Session log cleared." + "\n";

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