Sample code for 30+ languages & platforms
Xbase++ Requires Chilkat v11.0.0+

Check Gmail from a scheduled job after one-time consent

See more GMail REST API Examples

First run desktop authorization with gmail.readonly and offline access. This applies to personal Gmail and Workspace accounts subject to organization policies. Configure a job to run this code using the same private working directory and user identity. Each run refreshes the token and displays up to ten inbox message headers.

Save the original OAuth client credentials in a private gmail-client.json containing client_id and client_secret. The existing gmail-token.json supplies the refresh token. Use protected credential storage in a deployed application and serialize runs sharing these files. An invalid_grant response requires reconnecting the account. External OAuth apps in Testing normally receive refresh tokens that expire after seven days when Gmail scopes are requested. Google token expiration guidance.

This is a repeatable inbox check. To process each mailbox change across runs, see mailbox synchronization.

Google documentation

Chilkat Xbase++ Downloads

Xbase++
LOCAL nSuccess
LOCAL oFiles
LOCAL nFileStatus
LOCAL nBackupStatus
LOCAL oToken
LOCAL oClient
LOCAL oHttp
LOCAL oForm
LOCAL oResp
LOCAL oReply
LOCAL oIds
LOCAL i
LOCAL oUrl
LOCAL h

nSuccess := 0

//  Assumes Chilkat is unlocked. See Global Unlock Sample.

oFiles := CreateObject("Chilkat.FileAccess")
//  Recover the previous complete file if a run stopped during replacement.
nFileStatus := oFiles:FileExists3("gmail-token.json")
IF (nFileStatus < 0)
    ? "Could not inspect gmail-token.json."
    oFiles:destroy()
    RETURN
ENDIF

IF (nFileStatus == 0)
    nBackupStatus := oFiles:FileExists3("gmail-token.json.previous")
    IF (nBackupStatus < 0)
        ? "Could not inspect the backup file."
        oFiles:destroy()
        RETURN
    ENDIF

    IF (nBackupStatus == 1)
        nSuccess := oFiles:FileRename("gmail-token.json.previous", "gmail-token.json")
        IF (nSuccess != 1)
            ? "Could not restore the previous complete file."
            oFiles:destroy()
            RETURN
        ENDIF

        nFileStatus := 1
    ENDIF

ENDIF

oToken := CreateObject("Chilkat.JsonObject")
nSuccess := oToken:LoadFile("gmail-token.json")
IF (nSuccess != 1)
    ? "Could not read gmail-token.json from the private working directory."
    oFiles:destroy()
    oToken:destroy()
    RETURN
ENDIF

IF ((oToken:JsonTypeOf("refresh_token") != 1) .OR. (oToken:StringOfEquals("refresh_token", "", 1) == 1))
    ? "Authorize this account for offline access first."
    oFiles:destroy()
    oToken:destroy()
    RETURN
ENDIF

oClient := CreateObject("Chilkat.JsonObject")
nSuccess := oClient:LoadFile("gmail-client.json")
IF (nSuccess != 1)
    ? "Could not load the private OAuth client file."
    oFiles:destroy()
    oToken:destroy()
    oClient:destroy()
    RETURN
ENDIF

IF ((oClient:JsonTypeOf("client_id") != 1) .OR. (oClient:JsonTypeOf("client_secret") != 1))
    ? "gmail-client.json must contain client_id and client_secret."
    oFiles:destroy()
    oToken:destroy()
    oClient:destroy()
    RETURN
ENDIF

oHttp := CreateObject("Chilkat.Http")
oHttp:RequireSslCertVerify := 1
oForm := CreateObject("Chilkat.HttpRequest")
oForm:HttpVerb := "POST"
oForm:ContentType := "application/x-www-form-urlencoded"
oForm:AddParam("grant_type", "refresh_token")
oForm:AddParam("client_id", oClient:StringOf("client_id"))
oForm:AddParam("client_secret", oClient:StringOf("client_secret"))
oForm:AddParam("refresh_token", oToken:StringOf("refresh_token"))
oResp := CreateObject("Chilkat.HttpResponse")
oReply := CreateObject("Chilkat.JsonObject")
nSuccess := oHttp:HttpReq("https://oauth2.googleapis.com/token", oForm, oResp)
IF (oResp:StatusCode == 0)
    ? "The token endpoint did not return an HTTP response."
    oFiles:destroy()
    oToken:destroy()
    oClient:destroy()
    oHttp:destroy()
    oForm:destroy()
    oResp:destroy()
    oReply:destroy()
    RETURN
ENDIF

IF ((nSuccess != 1) .OR. (oResp:StatusCode != 200))
    ? "Token refresh failed. HTTP " + Str(oResp:StatusCode)
    nSuccess := oReply:Load(oResp:BodyStr)
    IF (nSuccess == 1)
        IF (oReply:StringOfEquals("error", "invalid_grant", 1) == 1)
            ? "Reconnect this account with interactive authorization."
        ENDIF

    ENDIF

    oFiles:destroy()
    oToken:destroy()
    oClient:destroy()
    oHttp:destroy()
    oForm:destroy()
    oResp:destroy()
    oReply:destroy()
    RETURN
ENDIF

nSuccess := oReply:Load(oResp:BodyStr)
IF (nSuccess != 1)
    ? "Could not parse the refresh response."
    oFiles:destroy()
    oToken:destroy()
    oClient:destroy()
    oHttp:destroy()
    oForm:destroy()
    oResp:destroy()
    oReply:destroy()
    RETURN
ENDIF

IF ((oReply:JsonTypeOf("access_token") != 1) .OR. (oReply:StringOfEquals("access_token", "", 1) == 1))
    ? "Expected access_token in the response."
    oFiles:destroy()
    oToken:destroy()
    oClient:destroy()
    oHttp:destroy()
    oForm:destroy()
    oResp:destroy()
    oReply:destroy()
    RETURN
ENDIF

//  Google usually omits the refresh token. Preserve it unless a replacement is returned.
IF ((oReply:JsonTypeOf("refresh_token") != 1) .OR. (oReply:StringOfEquals("refresh_token", "", 1) == 1))
    nSuccess := oReply:UpdateString("refresh_token", oToken:StringOf("refresh_token"))
    IF (nSuccess != 1)
        ? oReply:LastErrorText
        oFiles:destroy()
        oToken:destroy()
        oClient:destroy()
        oHttp:destroy()
        oForm:destroy()
        oResp:destroy()
        oReply:destroy()
        RETURN
    ENDIF

ENDIF

IF ((oReply:HasMember("scope") != 1) .AND. (oToken:JsonTypeOf("scope") == 1))
    nSuccess := oReply:UpdateString("scope", oToken:StringOf("scope"))
    IF (nSuccess != 1)
        ? oReply:LastErrorText
        oFiles:destroy()
        oToken:destroy()
        oClient:destroy()
        oHttp:destroy()
        oForm:destroy()
        oResp:destroy()
        oReply:destroy()
        RETURN
    ENDIF

ENDIF

//  Prepare the complete replacement before moving the last committed file.
nSuccess := oReply:WriteFile("gmail-token.json.new")
IF (nSuccess != 1)
    ? "Could not write the replacement file."
    oFiles:destroy()
    oToken:destroy()
    oClient:destroy()
    oHttp:destroy()
    oForm:destroy()
    oResp:destroy()
    oReply:destroy()
    RETURN
ENDIF

IF (oFiles:FileExists("gmail-token.json") == 1)
    IF (oFiles:FileExists("gmail-token.json.previous") == 1)
        nSuccess := oFiles:FileDelete("gmail-token.json.previous")
        IF (nSuccess != 1)
            ? "Could not rotate the previous backup."
            oFiles:destroy()
            oToken:destroy()
            oClient:destroy()
            oHttp:destroy()
            oForm:destroy()
            oResp:destroy()
            oReply:destroy()
            RETURN
        ENDIF

    ENDIF

    nSuccess := oFiles:FileRename("gmail-token.json", "gmail-token.json.previous")
    IF (nSuccess != 1)
        ? "Could not retain the previous complete file."
        oFiles:destroy()
        oToken:destroy()
        oClient:destroy()
        oHttp:destroy()
        oForm:destroy()
        oResp:destroy()
        oReply:destroy()
        RETURN
    ENDIF

ENDIF

nSuccess := oFiles:FileRename("gmail-token.json.new", "gmail-token.json")
IF (nSuccess != 1)
    ? "Could not commit the replacement. The previous complete file is retained."
    oFiles:destroy()
    oToken:destroy()
    oClient:destroy()
    oHttp:destroy()
    oForm:destroy()
    oResp:destroy()
    oReply:destroy()
    RETURN
ENDIF

oHttp:AuthToken := oReply:StringOf("access_token")
nSuccess := oHttp:HttpNoBody("GET", "https://gmail.googleapis.com/gmail/v1/users/me/messages?labelIds=INBOX&maxResults=10", oResp)
IF (oResp:StatusCode == 0)
    ? "Gmail did not return an HTTP response."
    oFiles:destroy()
    oToken:destroy()
    oClient:destroy()
    oHttp:destroy()
    oForm:destroy()
    oResp:destroy()
    oReply:destroy()
    RETURN
ENDIF

IF ((nSuccess != 1) .OR. (oResp:StatusCode < 200) .OR. (oResp:StatusCode >= 300))
    ? "Gmail HTTP " + Str(oResp:StatusCode)
    nSuccess := oReply:Load(oResp:BodyStr)
    IF (nSuccess == 1)
        ? oReply:StringOf("error.message")
    ENDIF

    oFiles:destroy()
    oToken:destroy()
    oClient:destroy()
    oHttp:destroy()
    oForm:destroy()
    oResp:destroy()
    oReply:destroy()
    RETURN
ENDIF

nSuccess := oReply:Load(oResp:BodyStr)
IF (nSuccess != 1)
    ? "Expected a Gmail JSON response."
    oFiles:destroy()
    oToken:destroy()
    oClient:destroy()
    oHttp:destroy()
    oForm:destroy()
    oResp:destroy()
    oReply:destroy()
    RETURN
ENDIF

oIds := CreateObject("Chilkat.StringTable")
i := 0
DO WHILE (i < oReply:SizeOfArray("messages"))
    oReply:I := i
    nSuccess := oIds:Append(oReply:StringOf("messages[i].id"))
    IF (nSuccess != 1)
        ? oIds:LastErrorText
        oFiles:destroy()
        oToken:destroy()
        oClient:destroy()
        oHttp:destroy()
        oForm:destroy()
        oResp:destroy()
        oReply:destroy()
        oIds:destroy()
        RETURN
    ENDIF

    i := i + 1
ENDDO
oUrl := CreateObject("Chilkat.StringBuilder")
i := 0
DO WHILE (i < oIds:Count)
    oUrl:SetString("https://gmail.googleapis.com/gmail/v1/users/me/messages/")
    oUrl:Append(oHttp:UrlEncode(oIds:StringAt(i)))
    oUrl:Append("?format=metadata&metadataHeaders=From&metadataHeaders=Subject")
    nSuccess := oHttp:HttpNoBody("GET", oUrl:GetAsString(), oResp)
    IF (oResp:StatusCode == 0)
        ? "Gmail did not return an HTTP response."
        oFiles:destroy()
        oToken:destroy()
        oClient:destroy()
        oHttp:destroy()
        oForm:destroy()
        oResp:destroy()
        oReply:destroy()
        oIds:destroy()
        oUrl:destroy()
        RETURN
    ENDIF

    IF ((nSuccess != 1) .OR. (oResp:StatusCode < 200) .OR. (oResp:StatusCode >= 300))
        ? "Gmail HTTP " + Str(oResp:StatusCode)
        nSuccess := oReply:Load(oResp:BodyStr)
        IF (nSuccess == 1)
            ? oReply:StringOf("error.message")
        ENDIF

        oFiles:destroy()
        oToken:destroy()
        oClient:destroy()
        oHttp:destroy()
        oForm:destroy()
        oResp:destroy()
        oReply:destroy()
        oIds:destroy()
        oUrl:destroy()
        RETURN
    ENDIF

    nSuccess := oReply:Load(oResp:BodyStr)
    IF (nSuccess != 1)
        ? "Expected a Gmail JSON response."
        oFiles:destroy()
        oToken:destroy()
        oClient:destroy()
        oHttp:destroy()
        oForm:destroy()
        oResp:destroy()
        oReply:destroy()
        oIds:destroy()
        oUrl:destroy()
        RETURN
    ENDIF

    ? "Message: " + oIds:StringAt(i)
    h := 0
    DO WHILE (h < oReply:SizeOfArray("payload.headers"))
        oReply:I := h
        ? oReply:StringOf("payload.headers[i].name") + ": " + oReply:StringOf("payload.headers[i].value")
        h := h + 1
    ENDDO
    i := i + 1
ENDDO
? "Inbox messages checked: " + Str(oIds:Count)

oFiles:destroy()
oToken:destroy()
oClient:destroy()
oHttp:destroy()
oForm:destroy()
oResp:destroy()
oReply:destroy()
oIds:destroy()
oUrl:destroy()