PureBasic

POP3 GMail XOAUTH2 Authentication

See more GMail SMTP/IMAP/POP Examples

Demonstrates using OAuth2 authentication with pop.gmail.com.

Note: This example requires Chilkat v9.5.0.83 or greater.

PureBasic

IncludeFile "CkMailMan.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    success.i = 0

    ; This example requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    mailman.i = CkMailMan::ckCreate()
    If mailman.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkMailMan::setCkMailHost(mailman, "pop.gmail.com")
    CkMailMan::setCkMailPort(mailman, 995)
    CkMailMan::setCkPopSsl(mailman, 1)

    CkMailMan::setCkPopUsername(mailman, "my_account@gmail.com")

    ; If using OAuth2 authentication, leave the password empty.
    CkMailMan::setCkPopPassword(mailman, "")

    ; Load our previously obtained OAuth2 access token.
    ; See Getting a GMail POP3 OAuth2 Access Token
    jsonToken.i = CkJsonObject::ckCreate()
    If jsonToken.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkJsonObject::ckLoadFile(jsonToken,"qa_data/tokens/gmail_pop3.json")
    If success = 0
        Debug CkJsonObject::ckLastErrorText(jsonToken)
        CkMailMan::ckDispose(mailman)
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    CkMailMan::setCkOAuth2AccessToken(mailman, CkJsonObject::ckStringOf(jsonToken,"access_token"))

    ; Make the TLS connection to the POP3 server.
    success = CkMailMan::ckPop3Connect(mailman)
    If success <> 1
        Debug CkMailMan::ckLastErrorText(mailman)
        CkMailMan::ckDispose(mailman)
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    ; Authenticate..
    success = CkMailMan::ckPop3Authenticate(mailman)
    If success <> 1
        Debug CkMailMan::ckLastErrorText(mailman)
        CkMailMan::ckDispose(mailman)
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    ; Find out how many emails are on the server..
    numEmails.i = CkMailMan::ckCheckMail(mailman)
    If numEmails < 0
        Debug CkMailMan::ckLastErrorText(mailman)
        CkMailMan::ckDispose(mailman)
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    ; Examine the POP3 session log:
    Debug CkMailMan::ckPop3SessionLog(mailman)

    ; The POP3 session log will look something like this:

    ; **** Connected to pop.gmail.com:995
    ; < +OK Gpop ready for requests from 87.9.200.42 l16mb86351205iok
    ; > AUTH XOAUTH2 dXNlcj1....VaMDJFAQE=
    ; < +OK Welcome.
    ; > STAT
    ; < +OK 301 1627357
    ; 
    ; -- Finished.

    ; End the POP3 session and close the connection to the GMail server.
    success = CkMailMan::ckPop3EndSession(mailman)
    If success <> 1
        Debug CkMailMan::ckLastErrorText(mailman)
        CkMailMan::ckDispose(mailman)
        CkJsonObject::ckDispose(jsonToken)
        ProcedureReturn
    EndIf

    Debug "-- Finished."


    CkMailMan::ckDispose(mailman)
    CkJsonObject::ckDispose(jsonToken)


    ProcedureReturn
EndProcedure