(Lianja) Examine Yahoo Mail IMAP Session Log

See more Yahoo Mail Examples

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

Chilkat Lianja Extension Download Chilkat Lianja Extension

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

loJson = createobject("CkJsonObject")
llSuccess = loJson.LoadFile("qa_data/tokens/yahooMail.json")
if (llSuccess <> .T.) then
    ? "Failed to load Yahoo Mail access token file."
    release loJson
    return
endif

lcAccessToken = loJson.StringOf("access_token")

// Do OAuth2 authentication by using the access token as the password in the Login method below...
loImap = createobject("CkImap")

loImap.Ssl = .T.
loImap.Port = 993

// Tell Chilkat IMAP to keep a session log.
loImap.KeepSessionLog = .T.

// Connect to the Yahoo IMAP server.
llSuccess = loImap.Connect("imap.mail.yahoo.com")
if (llSuccess <> .T.) then
    ? loImap.LastErrorText
    release loJson
    release loImap
    return
endif

// Indicate that XOAUTH2 authentication is to be used:
loImap.AuthMethod = "XOAUTH2"

// Login
// Use the email address of the Yahoo Mail account that granted authorization.
llSuccess = loImap.Login("user@yahoo.com",lcAccessToken)
if (llSuccess <> .T.) then
    ? loImap.LastErrorText
else
    ? "Successfully authenticated with Yahoo IMAP using XOAUTH2!"
endif

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

lcRefName = ""
// 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:
lcWildcardedMailbox = "*"

loMboxes = loImap.ListMailboxes(lcRefName,lcWildcardedMailbox)
if (loImap.LastMethodSuccess = .F.) then
    ? loImap.LastErrorText
    release loJson
    release loImap
    return
endif

i = 0
do while i < loMboxes.Count
    ? loMboxes.GetName(i)
    i = i + 1
enddo

// Sample output looks like this:

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

// Examine the session log
? loImap.SessionLog

// 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.
llSuccess = loImap.Disconnect()

release loMboxes


release loJson
release loImap