(PureBasic) OAuth2 for a GMail using a Service Account Key

Demonstrates how to use GMail with OAuth2 for a Google Service Account. The 1st step is to obtain a temporary access token from the Google OAuth 2.0 Authorization Server. This can be accomplished using Chilkat HTTP.

Once the access token is obtained, it may be used to send email. The access token may be used while it remains valid to send as many emails as desired. Once it expires, a new access token needs to be obtained (using the same procedure).

Note: This is for OAuth2 using Google Service account keys.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkCert.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkEmail.pb"
IncludeFile "CkMailMan.pb"

Procedure ChilkatExample()

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

    ; --------------------------------------------------------------------
    ; Important:  In most cases, this example is not what you are looking for.
    ; This example is for OAuth2 using a Google Service Account Key.
    ; 
    ; It is more likely that the example you actually need is here:
    ; Get GMail SMTP Access Token 
    ; --------------------------------------------------------------------

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

    ; When a service account (Client ID) is created at https://code.google.com/apis/console/
    ; Google will generate a P12 key.  This is a PKCS12 (PFX) file that you will download
    ; and save.  The password to access the contents of this file is "notasecret".
    ; NOTE: The Chilkat Pfx API provides the ability to load a PFX/P12 and re-save
    ; with a different password.

    ; Begin by loading the downloaded .p12 into a Chilkat certificate object:
    cert.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkCert::ckLoadPfxFile(cert,"/myDir/API Project-1c43a291e2a1-notasecret.p12","notasecret")
    If success <> 1
        Debug CkCert::ckLastErrorText(cert)
        CkHttp::ckDispose(http)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ; The next (and final) step is to request the access token.  Chilkat internally
    ; does all the work of forming the JWT header and JWT claim set, encoding and
    ; signing the JWT, and sending the access token request.
    ; The application need only provide the inputs: The iss, scope(s), sub, and the
    ; desired duration with a max of 3600 seconds (1 hour).
    ; 
    ; Each of these inputs is defined as follows 
    ; (see https://developers.google.com/accounts/docs/OAuth2ServiceAccount
    ; iss: The email address of the service account.
    ; scope: A space-delimited list of the permissions that the application requests.
    ; sub: The email address of the user for which the application is requesting delegated access.
    ;       the "sub" may be empty if no delegation exists.
    ; numSec: The number of seconds for which the access token will be valid (max 3600).

    iss.s = "761326798069-r5mljlln1rd4lrbhg75efgigp36m78j5@developer.gserviceaccount.com"
    scope.s = "https://mail.google.com/"
    ; The sub should be your Google Apps user email address (not a gmail.com address)
    oauth_sub.s = "YOUR_GOOGLE_APPS_USER_EMAIL_ADDRESS"
    numSec.i = 3600

    accessToken.s = CkHttp::ckG_SvcOauthAccessToken(http,iss,scope,oauth_sub,numSec,cert)
    If CkHttp::ckLastMethodSuccess(http) <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkCert::ckDispose(cert)
        ProcedureReturn
    Else
        Debug "access token: " + accessToken
    EndIf

    ; Now that we have the access token, it may be used to send as many emails as desired
    ; while it remains valid.  Once the access token expires, a new access token should be
    ; retrieved and used.

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

    ; Set the properties for the GMail SMTP server:
    CkMailMan::setCkSmtpHost(mailman, "smtp.gmail.com")
    CkMailMan::setCkSmtpPort(mailman, 587)
    CkMailMan::setCkStartTLS(mailman, 1)

    CkMailMan::setCkSmtpUsername(mailman, "YOUR_GOOGLE_APPS_USER_EMAIL_ADDRESS")
    CkMailMan::setCkOAuth2AccessToken(mailman, accessToken)

    ; Create a new email object
    email.i = CkEmail::ckCreate()
    If email.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkEmail::setCkSubject(email, "This is a test")
    CkEmail::setCkBody(email, "This is a test")
    CkEmail::setCkFrom(email, "YOUR NAME <YOUR_GOOGLE_APPS_USER_EMAIL_ADDRESS>")
    success = CkEmail::ckAddTo(email,"Chilkat Admin","admin@chilkatsoft.com")
    ; To add more recipients, call AddTo, AddCC, or AddBcc once per recipient.

    ; Call SendEmail to connect to the SMTP server and send.
    ; The connection (i.e. session) to the SMTP server remains
    ; open so that subsequent SendEmail calls may use the
    ; same connection.  
    success = CkMailMan::ckSendEmail(mailman,email)
    If success <> 1
        Debug CkMailMan::ckLastErrorText(mailman)
        CkHttp::ckDispose(http)
        CkCert::ckDispose(cert)
        CkMailMan::ckDispose(mailman)
        CkEmail::ckDispose(email)
        ProcedureReturn
    EndIf

    ; You may close the connection here.  If the connection is kept open, 
    ; the next call to mailman.SendEmail will continue using the already-established connection
    ; (and automatically re-connect if needed).
    success = CkMailMan::ckCloseSmtpConnection(mailman)
    If success <> 1
        Debug "Connection to SMTP server not closed cleanly."
    EndIf

    Debug "Email Sent via GMail using an OAuth2 Service Account Key."


    CkHttp::ckDispose(http)
    CkCert::ckDispose(cert)
    CkMailMan::ckDispose(mailman)
    CkEmail::ckDispose(email)


    ProcedureReturn
EndProcedure