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

Read selected headers for a page of Gmail messages

See more GMail REST API Examples

List up to five messages and fetch only From, Subject, and Date for each one. Request metadataHeaders once per header name. Read the returned headers by name because order and presence vary. This header preview leaves the MIME body on Gmail.

Authorize the application with https://www.googleapis.com/auth/gmail.metadata. 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 oIds
LOCAL nCount
LOCAL i
LOCAL oUrl
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")
nSuccess := oHttp:HttpNoBody("GET", "https://gmail.googleapis.com/gmail/v1/users/me/messages?maxResults=5", oResp)
IF (oResp:StatusCode == 0)
    ? "Gmail did not return an HTTP response."
    oToken:destroy()
    oHttp: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

    oToken:destroy()
    oHttp:destroy()
    oResp:destroy()
    oReply:destroy()
    RETURN
ENDIF

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

oIds := CreateObject("Chilkat.StringTable")
nCount := oReply:SizeOfArray("messages")
i := 0
DO WHILE (i < nCount)
    oReply:I := i
    nSuccess := oIds:Append(oReply:StringOf("messages[i].id"))
    IF (nSuccess != 1)
        ? "Could not retain a message ID."
        oToken:destroy()
        oHttp: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(oIds:StringAt(i))
    oUrl:Append("?format=metadata&metadataHeaders=From&metadataHeaders=Subject&metadataHeaders=Date")
    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()
        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

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

    nSuccess := oReply:Load(oResp:BodyStr)
    IF (nSuccess != 1)
        ? "Expected a Gmail JSON response."
        oToken:destroy()
        oHttp: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
? "Messages inspected: " + Str(oIds:Count)

oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oIds:destroy()
oUrl:destroy()