Delphi DLL 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. Delphi DLL

var
success: Boolean;
json: HCkJsonObject;
accessToken: PWideChar;
imap: HCkImap;
refName: PWideChar;
wildcardedMailbox: PWideChar;
subscribed: Boolean;
mboxes: HCkMailboxes;
i: Integer;

begin
success := False;

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

json := CkJsonObject_Create();
success := CkJsonObject_LoadFile(json,'qa_data/tokens/yahooMail.json');
if (success <> True) then
  begin
    Memo1.Lines.Add('Failed to load Yahoo Mail access token file.');
    Exit;
  end;
accessToken := CkJsonObject__stringOf(json,'access_token');

//  Do OAuth2 authentication by using the access token as the password in the Login method below...
imap := CkImap_Create();

CkImap_putSsl(imap,True);
CkImap_putPort(imap,993);

//  Tell Chilkat IMAP to keep a session log.
CkImap_putKeepSessionLog(imap,True);

//  Connect to the Yahoo IMAP server.
success := CkImap_Connect(imap,'imap.mail.yahoo.com');
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

//  Indicate that XOAUTH2 authentication is to be used:
CkImap_putAuthMethod(imap,'XOAUTH2');

//  Login
//  Use the email address of the Yahoo Mail account that granted authorization.
success := CkImap_Login(imap,'user@yahoo.com',accessToken);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
  end
else
  begin
    Memo1.Lines.Add('Successfully authenticated with Yahoo IMAP using XOAUTH2!');
  end;

//  Get the list of mailboxes.
refName := '';
wildcardedMailbox := '*';
subscribed := False;

mboxes := CkMailboxes_Create();
success := CkImap_MbxList(imap,subscribed,refName,wildcardedMailbox,mboxes);
if (success = False) then
  begin
    Memo1.Lines.Add(CkImap__lastErrorText(imap));
    Exit;
  end;

i := 0;
while i < CkMailboxes_getCount(mboxes) do
  begin
    Memo1.Lines.Add(CkMailboxes__getName(mboxes,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
Memo1.Lines.Add(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.
success := CkImap_Disconnect(imap);

CkJsonObject_Dispose(json);
CkImap_Dispose(imap);
CkMailboxes_Dispose(mboxes);