(PureBasic) Yahoo IMAP Authentication using OAuth2 Access Token

See more Yahoo Mail Examples

Demonstrates how to do IMAP OAuth2 authentication for Yahoo (or any other IMAP mail server supporting OAuth2 authentication). This example assumes an OAuth2 access token was previously obtained.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkImap.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    ; This example requires 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.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkJsonObject::ckLoadFile(json,"qa_data/tokens/yahooMail.json")
    If success <> 1
        Debug "Failed to load GMail access token file."
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    accessToken.s = CkJsonObject::ckStringOf(json,"access_token")

    ; Do OAuth2 authentication by using the access token as the password in the Login method below...
    imap.i = CkImap::ckCreate()
    If imap.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkImap::setCkSsl(imap, 1)
    CkImap::setCkPort(imap, 993)

    ; Connect to the Yahoo IMAP server.
    success = CkImap::ckConnect(imap,"imap.mail.yahoo.com")
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
        CkJsonObject::ckDispose(json)
        CkImap::ckDispose(imap)
        ProcedureReturn
    EndIf

    ; Indicate that XOAUTH2 authentication is to be used:
    CkImap::setCkAuthMethod(imap, "XOAUTH2")

    ; Login
    ; Use the email address of the GMail account that granted authorization.
    success = CkImap::ckLogin(imap,"user@yahoo.com",accessToken)
    If success <> 1
        Debug CkImap::ckLastErrorText(imap)
    Else
        Debug "Successfully authenticated with Yahoo IMAP using XOAUTH2!"
    EndIf



    CkJsonObject::ckDispose(json)
    CkImap::ckDispose(imap)


    ProcedureReturn
EndProcedure