(PowerBuilder) 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 ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_Json
integer li_Success
string ls_AccessToken
oleobject loo_Imap
string ls_RefName
string ls_WildcardedMailbox
oleobject loo_Mboxes
integer i

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

loo_Json = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_Json.ConnectToNewObject("Chilkat.JsonObject")
if li_rc < 0 then
    destroy loo_Json
    MessageBox("Error","Connecting to COM object failed")
    return
end if
li_Success = loo_Json.LoadFile("qa_data/tokens/yahooMail.json")
if li_Success <> 1 then
    Write-Debug "Failed to load Yahoo Mail access token file."
    destroy loo_Json
    return
end if

ls_AccessToken = loo_Json.StringOf("access_token")

// Do OAuth2 authentication by using the access token as the password in the Login method below...
loo_Imap = create oleobject
// Use "Chilkat_9_5_0.Imap" for versions of Chilkat < 10.0.0
li_rc = loo_Imap.ConnectToNewObject("Chilkat.Imap")

loo_Imap.Ssl = 1
loo_Imap.Port = 993

// Tell Chilkat IMAP to keep a session log.
loo_Imap.KeepSessionLog = 1

// Connect to the Yahoo IMAP server.
li_Success = loo_Imap.Connect("imap.mail.yahoo.com")
if li_Success <> 1 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Json
    destroy loo_Imap
    return
end if

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

// Login
// Use the email address of the Yahoo Mail account that granted authorization.
li_Success = loo_Imap.Login("user@yahoo.com",ls_AccessToken)
if li_Success <> 1 then
    Write-Debug loo_Imap.LastErrorText
else
    Write-Debug "Successfully authenticated with Yahoo IMAP using XOAUTH2!"
end if

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

ls_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:
ls_WildcardedMailbox = "*"

loo_Mboxes = loo_Imap.ListMailboxes(ls_RefName,ls_WildcardedMailbox)
if loo_Imap.LastMethodSuccess = 0 then
    Write-Debug loo_Imap.LastErrorText
    destroy loo_Json
    destroy loo_Imap
    return
end if

i = 0
do while i < loo_Mboxes.Count
    Write-Debug loo_Mboxes.GetName(i)
    i = i + 1
loop

// Sample output looks like this:

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

// Examine the session log
Write-Debug loo_Imap.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.
li_Success = loo_Imap.Disconnect()

destroy loo_Mboxes


destroy loo_Json
destroy loo_Imap