Xbase++ Requires Chilkat v11.0.0+

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. Xbase++

LOCAL nSuccess
LOCAL oJson
LOCAL cAccessToken
LOCAL oImap
LOCAL cRefName
LOCAL cWildcardedMailbox
LOCAL nSubscribed
LOCAL oMboxes
LOCAL i

nSuccess := 0

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

oJson := CreateObject("Chilkat.JsonObject")
nSuccess := oJson:LoadFile("qa_data/tokens/yahooMail.json")
IF (nSuccess != 1)
    ? "Failed to load Yahoo Mail access token file."
    oJson:destroy()
    RETURN
ENDIF

cAccessToken := oJson:StringOf("access_token")

//  Do OAuth2 authentication by using the access token as the password in the Login method below...
oImap := CreateObject("Chilkat.Imap")

oImap:Ssl := 1
oImap:Port := 993

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

//  Connect to the Yahoo IMAP server.
nSuccess := oImap:Connect("imap.mail.yahoo.com")
IF (nSuccess == 0)
    ? oImap:LastErrorText
    oJson:destroy()
    oImap:destroy()
    RETURN
ENDIF

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

//  Login
//  Use the email address of the Yahoo Mail account that granted authorization.
nSuccess := oImap:Login("user@yahoo.com", cAccessToken)
IF (nSuccess != 1)
    ? oImap:LastErrorText
ELSE
    ? "Successfully authenticated with Yahoo IMAP using XOAUTH2!"
ENDIF

//  Get the list of mailboxes.
cRefName := ""
cWildcardedMailbox := "*"
nSubscribed := 0

oMboxes := CreateObject("Chilkat.Mailboxes")
nSuccess := oImap:MbxList(nSubscribed, cRefName, cWildcardedMailbox, oMboxes)
IF (nSuccess == 0)
    ? oImap:LastErrorText
    oJson:destroy()
    oImap:destroy()
    oMboxes:destroy()
    RETURN
ENDIF

i := 0
DO WHILE i < oMboxes:Count
    ? oMboxes: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
? oImap: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.
nSuccess := oImap:Disconnect()

oJson:destroy()
oImap:destroy()
oMboxes:destroy()