(Ruby) Examine Yahoo Mail IMAP Session Log

See more Yahoo Mail Examples

To examine the IMAP session log, set the KeepSessionLog property = true, and then examine the contents of the SessionLog property.

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.

# See Get Yahoo Mail OAuth2 Access Token for Desktop App 
# for sample code showing how to obtain a Yahoo Mail access token.

# In this example, our access token was previously saved to the following file which contains JSON like this:
# {
#   "access_token": "kCVQdnOdul...LHucA--",
#   "refresh_token": "AIenVXETSo0jklFBVkPS8vVm8E.Ej9ToRG.xDbDYmZ65WIs5t6CZhDrD",
#   "expires_in": 3600,
#   "token_type": "bearer",
#   "xoauth_yahoo_guid": "HGDQCVF5JB4YDOWHITQJFBHCWA"
# }

json = Chilkat::CkJsonObject.new()
success = json.LoadFile("qa_data/tokens/yahooMail.json")
if (success != true)
    print "Failed to load Yahoo Mail access token file." + "\n";
    exit
end

accessToken = json.stringOf("access_token")

# Do OAuth2 authentication by using the access token as the password in the Login method below...
imap = Chilkat::CkImap.new()

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

# Tell Chilkat IMAP to keep a session log.
imap.put_KeepSessionLog(true)

# Connect to the Yahoo IMAP server.
success = imap.Connect("imap.mail.yahoo.com")
if (success != true)
    print imap.lastErrorText() + "\n";
    exit
end

# Indicate that XOAUTH2 authentication is to be used:
imap.put_AuthMethod("XOAUTH2")

# Login
# Use the email address of the Yahoo Mail account that granted authorization.
success = imap.Login("user@yahoo.com",accessToken)
if (success != true)
    print imap.lastErrorText() + "\n";
else
    print "Successfully authenticated with Yahoo IMAP using XOAUTH2!" + "\n";
end

# The ListMailboxes method returns a Mailboxes object
# that contains the collection of mailboxes.
# It accepts two arguments: a refName and a wildcardedMailbox.

refName = ""
# refName is usually set to an empty string.
# A non-empty reference name argument is the name of a mailbox or a level of
# mailbox hierarchy, and indicates the context in which the mailbox
# name is interpreted.

# Select all mailboxes matching this pattern:
wildcardedMailbox = "*"

# mboxes is a CkMailboxes
mboxes = imap.ListMailboxes(refName,wildcardedMailbox)
if (imap.get_LastMethodSuccess() == false)
    print imap.lastErrorText() + "\n";
    exit
end

i = 0
while i < mboxes.get_Count()
    print mboxes.getName(i) + "\n";
    i = i + 1
end

# Sample output looks like this:

# Archive
# Bulk Mail
# Draft
# Inbox
# Inbox/emailsWithAttach
# Inbox/test
# Sent
# Trash

# Examine the session log
print imap.sessionLog() + "\n";

# Sample session log

# ----INFO----
# Connecting to IMAP server at imap.mail.yahoo.com:993
# ----IMAP RESPONSE----
# * OK [CAPABILITY IMAP4rev1 SASL-IR AUTH=PLAIN AUTH=XOAUTH2 AUTH=OAUTHBEARER ID MOVE NAMESPACE XYMHIGHESTMODSEQ UIDPLUS LITERAL+ CHILDREN X-MSG-EXT OBJECTID] IMAP4rev1 Hello
# ----IMAP REQUEST----
# aaab AUTHENTICATE XOAUTH2 
# ----IMAP RESPONSE----
# aaab OK AUTHENTICATE completed
# ----IMAP REQUEST----
# aaac LIST "" "*"
# ----IMAP RESPONSE----
# * LIST (\Archive \HasNoChildren) "/" "Archive"
# * LIST (\Junk \HasNoChildren) "/" "Bulk Mail"
# * LIST (\Drafts \HasNoChildren) "/" "Draft"
# * LIST (\HasChildren) "/" "Inbox"
# * LIST (\HasNoChildren) "/" "Inbox/emailsWithAttach"
# * LIST (\HasNoChildren) "/" "Inbox/test"
# * LIST (\Sent \HasNoChildren) "/" "Sent"
# * LIST (\Trash \HasNoChildren) "/" "Trash"
# aaac OK LIST completed

# Disconnect from the IMAP server.
success = imap.Disconnect()