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

Search Gmail by sender, subject, date, or attachment

See more GMail REST API Examples

Choose a Gmail search query, follow every result page, and fetch From and Subject headers for each match. Edit the query to use operators such as from:, subject:, after:, before:, has:attachment, and filename:. Quoted phrases and special characters are URL-encoded once.

Gmail search dates use midnight Pacific Standard Time. Use Unix timestamps in seconds for exact date boundaries in another timezone. Spam and Trash are excluded unless includeSpamTrash=true is added. Search requires gmail.readonly or a broader mail scope. Query searches are unavailable with gmail.metadata.

Authorize the application with https://www.googleapis.com/auth/gmail.readonly. The example reads the access token from gmail-token.json in a private working directory. Authorize a desktop application.

Google documentation

Chilkat Xbase++ Downloads

Xbase++
LOCAL nSuccess
LOCAL oToken
LOCAL oHttp
LOCAL oResp
LOCAL oReply
LOCAL cSearchQuery
LOCAL oBaseUrl
LOCAL oUrl
LOCAL cPageToken
LOCAL oPage
LOCAL nTotal
LOCAL nMore
LOCAL i
LOCAL cMessageId
LOCAL h

nSuccess := 0

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

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

IF ((oToken:JsonTypeOf("access_token") != 1) .OR. (oToken:StringOfEquals("access_token", "", 1) == 1))
    ? "An OAuth access token is required."
    oToken:destroy()
    RETURN
ENDIF

oHttp := CreateObject("Chilkat.Http")
oHttp:RequireSslCertVerify := 1
oHttp:AuthToken := oToken:StringOf("access_token")
oResp := CreateObject("Chilkat.HttpResponse")
oReply := CreateObject("Chilkat.JsonObject")
cSearchQuery := "from:sender@example.com has:attachment filename:pdf"
oBaseUrl := CreateObject("Chilkat.StringBuilder")
oBaseUrl:Append("https://gmail.googleapis.com/gmail/v1/users/me/messages?maxResults=100&q=")
oBaseUrl:Append(oHttp:UrlEncode(cSearchQuery))
oUrl := CreateObject("Chilkat.StringBuilder")
cPageToken := ""
oPage := CreateObject("Chilkat.JsonObject")
nTotal := 0
nMore := 1
DO WHILE (nMore == 1)
    oUrl:SetString(oBaseUrl:GetAsString())
    oUrl:Append("&pageToken=")
    oUrl:Append(oHttp:UrlEncode(cPageToken))
    nSuccess := oHttp:HttpNoBody("GET", oUrl:GetAsString(), oResp)
    IF (oResp:StatusCode == 0)
        ? "Gmail did not return an HTTP response."
        oToken:destroy()
        oHttp:destroy()
        oResp:destroy()
        oReply:destroy()
        oBaseUrl:destroy()
        oUrl:destroy()
        oPage: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

        oToken:destroy()
        oHttp:destroy()
        oResp:destroy()
        oReply:destroy()
        oBaseUrl:destroy()
        oUrl:destroy()
        oPage:destroy()
        RETURN
    ENDIF

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

    //  Keep this page while individual message requests reuse reply.
    nSuccess := oReply:MakeCopy(oPage)
    IF (nSuccess != 1)
        ? oReply:LastErrorText
        oToken:destroy()
        oHttp:destroy()
        oResp:destroy()
        oReply:destroy()
        oBaseUrl:destroy()
        oUrl:destroy()
        oPage:destroy()
        RETURN
    ENDIF

    i := 0
    DO WHILE (i < oPage:SizeOfArray("messages"))
        oPage:I := i
        cMessageId := oPage:StringOf("messages[i].id")
        oUrl:SetString("https://gmail.googleapis.com/gmail/v1/users/me/messages/")
        oUrl:Append(oHttp:UrlEncode(cMessageId))
        oUrl:Append("?format=metadata&metadataHeaders=From&metadataHeaders=Subject")
        nSuccess := oHttp:HttpNoBody("GET", oUrl:GetAsString(), oResp)
        //  A message can disappear between the search and the metadata request.
        IF (oResp:StatusCode != 404)
            IF (oResp:StatusCode == 0)
                ? "Gmail did not return an HTTP response."
                oToken:destroy()
                oHttp:destroy()
                oResp:destroy()
                oReply:destroy()
                oBaseUrl:destroy()
                oUrl:destroy()
                oPage: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

                oToken:destroy()
                oHttp:destroy()
                oResp:destroy()
                oReply:destroy()
                oBaseUrl:destroy()
                oUrl:destroy()
                oPage:destroy()
                RETURN
            ENDIF

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

            ? "Message: " + cMessageId
            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
            nTotal := nTotal + 1
        ENDIF

        i := i + 1
    ENDDO
    cPageToken := ""
    IF (oPage:JsonTypeOf("nextPageToken") == 1)
        cPageToken := oPage:StringOf("nextPageToken")
    ENDIF

    nMore := cPageToken != ""
ENDDO
? "Matching messages read: " + Str(nTotal)

oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oBaseUrl:destroy()
oUrl:destroy()
oPage:destroy()