Lua 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. Lua

local chilkat = 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"
-- }

local json = chilkat.JsonObject.new()
local success = json:load_file("qa_data/tokens/yahooMail.json")
if not success then
    print("Failed to load Yahoo Mail access token file.")
    return
end

local accessToken = json:string_of("access_token")

-- Do OAuth2 authentication by using the access token as the password in the Login method below...
local imap = chilkat.Imap.new()

imap.ssl = true
imap.port = 993

-- Tell Chilkat IMAP to keep a session log.
imap.keep_session_log = true

-- Connect to the Yahoo IMAP server.
success = imap:connect("imap.mail.yahoo.com")
if not success then
    print(imap.last_error_text)
    return
end

-- Indicate that XOAUTH2 authentication is to be used:
imap.auth_method = "XOAUTH2"

-- Login
-- Use the email address of the Yahoo Mail account that granted authorization.
success = imap:login("user@yahoo.com", accessToken)
if not success then
    print(imap.last_error_text)
else
    print("Successfully authenticated with Yahoo IMAP using XOAUTH2!")
end

-- Get the list of mailboxes.
local refName = ""
local wildcardedMailbox = "*"
local subscribed = false

local mboxes = chilkat.Mailboxes.new()
success = imap:mbx_list(subscribed, refName, wildcardedMailbox, mboxes)
if not success then
    print(imap.last_error_text)
    return
end

local i = 0
while i < mboxes.count do
    print(mboxes:get_name(i))
    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.session_log)

-- 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()