(DataFlex) Examine Yahoo Mail IMAP Session Log

See more Yahoo Mail Examples

Note: This example requires Chilkat v11.0.0 or greater.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Handle hoJson
    String sAccessToken
    Handle hoImap
    String sRefName
    String sWildcardedMailbox
    Boolean iSubscribed
    Variant vMboxes
    Handle hoMboxes
    Integer i
    String sTemp1

    Move False To iSuccess

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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComLoadFile Of hoJson "qa_data/tokens/yahooMail.json" To iSuccess
    If (iSuccess <> True) Begin
        Showln "Failed to load Yahoo Mail access token file."
        Procedure_Return
    End

    Get ComStringOf Of hoJson "access_token" To sAccessToken

    // Do OAuth2 authentication by using the access token as the password in the Login method below...
    Get Create (RefClass(cComChilkatImap)) To hoImap
    If (Not(IsComObjectCreated(hoImap))) Begin
        Send CreateComObject of hoImap
    End

    Set ComSsl Of hoImap To True
    Set ComPort Of hoImap To 993

    // Tell Chilkat IMAP to keep a session log.
    Set ComKeepSessionLog Of hoImap To True

    // Connect to the Yahoo IMAP server.
    Get ComConnect Of hoImap "imap.mail.yahoo.com" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Indicate that XOAUTH2 authentication is to be used:
    Set ComAuthMethod Of hoImap To "XOAUTH2"

    // Login
    // Use the email address of the Yahoo Mail account that granted authorization.
    Get ComLogin Of hoImap "user@yahoo.com" sAccessToken To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
    End
    Else Begin
        Showln "Successfully authenticated with Yahoo IMAP using XOAUTH2!"
    End

    // Get the list of mailboxes.
    Move "" To sRefName
    Move "*" To sWildcardedMailbox
    Move False To iSubscribed

    Get Create (RefClass(cComChilkatMailboxes)) To hoMboxes
    If (Not(IsComObjectCreated(hoMboxes))) Begin
        Send CreateComObject of hoMboxes
    End
    Get pvComObject of hoMboxes to vMboxes
    Get ComMbxList Of hoImap iSubscribed sRefName sWildcardedMailbox vMboxes To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoImap To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Move 0 To i
    While (i < (ComCount(hoMboxes)))
        Get ComGetName Of hoMboxes i To sTemp1
        Showln sTemp1
        Move (i + 1) To i
    Loop

    // Sample output looks like this:

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

    // Examine the session log
    Get ComSessionLog Of hoImap To sTemp1
    Showln sTemp1

    // 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.
    Get ComDisconnect Of hoImap To iSuccess


End_Procedure