(Tcl) Examine Yahoo Mail IMAP Session Log

See more Yahoo Mail Examples

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

Chilkat Tcl Extension Downloads Chilkat Tcl Extension Downloads

load ./chilkat.dll

# 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"
# }

set json [new_CkJsonObject]

set success [CkJsonObject_LoadFile $json "qa_data/tokens/yahooMail.json"]
if {$success != 1} then {
    puts "Failed to load Yahoo Mail access token file."
    delete_CkJsonObject $json
    exit
}

set accessToken [CkJsonObject_stringOf $json "access_token"]

# Do OAuth2 authentication by using the access token as the password in the Login method below...
set imap [new_CkImap]

CkImap_put_Ssl $imap 1
CkImap_put_Port $imap 993

# Tell Chilkat IMAP to keep a session log.
CkImap_put_KeepSessionLog $imap 1

# Connect to the Yahoo IMAP server.
set success [CkImap_Connect $imap "imap.mail.yahoo.com"]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkJsonObject $json
    delete_CkImap $imap
    exit
}

# Indicate that XOAUTH2 authentication is to be used:
CkImap_put_AuthMethod $imap "XOAUTH2"

# Login
# Use the email address of the Yahoo Mail account that granted authorization.
set success [CkImap_Login $imap "user@yahoo.com" $accessToken]
if {$success != 1} then {
    puts [CkImap_lastErrorText $imap]
} else {
    puts "Successfully authenticated with Yahoo IMAP using XOAUTH2!"
}

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

set 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:
set wildcardedMailbox "*"

# mboxes is a CkMailboxes
set mboxes [CkImap_ListMailboxes $imap $refName $wildcardedMailbox]
if {[CkImap_get_LastMethodSuccess $imap] == 0} then {
    puts [CkImap_lastErrorText $imap]
    delete_CkJsonObject $json
    delete_CkImap $imap
    exit
}

set i 0
while {$i < [CkMailboxes_get_Count $mboxes]} {
    puts [CkMailboxes_getName $mboxes $i]
    set i [expr $i + 1]
}

# Sample output looks like this:

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

# Examine the session log
puts [CkImap_sessionLog $imap]

# 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.
set success [CkImap_Disconnect $imap]

delete_CkMailboxes $mboxes


delete_CkJsonObject $json
delete_CkImap $imap