Download a Gmail attachment by filename
See more GMail REST API Examples
Start with a Gmail message ID and the exact filename. Walk the root MIME payload and all nested parts. A unique matching part can contain base64url data directly or an attachment ID for a second request. Duplicate filenames are reported so the application can choose a particular MIME part.
The output path is chosen locally. The example saves to downloaded-attachment.bin and verifies the decoded size. Use an appropriate application-chosen filename or extension when adapting it. Gmail’s filename is treated as a matching value.
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.
Chilkat Xbase++ Downloads
LOCAL nSuccess
LOCAL oToken
LOCAL oHttp
LOCAL oResp
LOCAL oReply
LOCAL cMessageId
LOCAL cFilename
LOCAL oMessageUrl
LOCAL oUrl
LOCAL oPaths
LOCAL oPart
LOCAL oSelected
LOCAL oChildPath
LOCAL nMatches
LOCAL p
LOCAL j
LOCAL oBody
LOCAL nExpectedSize
LOCAL oData
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")
cMessageId := "GMAIL_MESSAGE_ID"
cFilename := "attachment.pdf"
oMessageUrl := CreateObject("Chilkat.StringBuilder")
oMessageUrl:Append("https://gmail.googleapis.com/gmail/v1/users/me/messages/")
oMessageUrl:Append(oHttp:UrlEncode(cMessageId))
oUrl := CreateObject("Chilkat.StringBuilder")
oUrl:Append(oMessageUrl:GetAsString())
oUrl:Append("?format=full")
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()
oMessageUrl: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()
oMessageUrl: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()
oMessageUrl:destroy()
oUrl:destroy()
RETURN
ENDIF
oPaths := CreateObject("Chilkat.StringTable")
nSuccess := oPaths:Append("payload")
IF (nSuccess != 1)
? oPaths:LastErrorText
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
RETURN
ENDIF
oPart := CreateObject("Chilkat.JsonObject")
oSelected := CreateObject("Chilkat.JsonObject")
oChildPath := CreateObject("Chilkat.StringBuilder")
nMatches := 0
p := 0
DO WHILE (p < oPaths:Count)
nSuccess := oReply:ObjectOf2(oPaths:StringAt(p), oPart)
IF (nSuccess != 1)
? oReply:LastErrorText
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
RETURN
ENDIF
IF (oPart:StringOfEquals("filename", cFilename, 1) == 1)
nMatches := nMatches + 1
nSuccess := oPart:MakeCopy(oSelected)
IF (nSuccess != 1)
? oPart:LastErrorText
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
RETURN
ENDIF
? "Matching MIME part: " + oPaths:StringAt(p)
ENDIF
j := 0
DO WHILE (j < oPart:SizeOfArray("parts"))
oChildPath:SetString(oPaths:StringAt(p))
oChildPath:Append(".parts[")
oChildPath:AppendInt(j)
oChildPath:Append("]")
nSuccess := oPaths:Append(oChildPath:GetAsString())
IF (nSuccess != 1)
? oPaths:LastErrorText
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
RETURN
ENDIF
j := j + 1
ENDDO
p := p + 1
ENDDO
IF (nMatches != 1)
? "Expected one filename match. Matches: " + Str(nMatches)
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
RETURN
ENDIF
oBody := CreateObject("Chilkat.JsonObject")
nSuccess := oSelected:ObjectOf2("body", oBody)
IF (nSuccess != 1)
? oSelected:LastErrorText
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
oBody:destroy()
RETURN
ENDIF
IF (oBody:JsonTypeOf("size") != 2)
? "The selected part has no byte count."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
oBody:destroy()
RETURN
ENDIF
nExpectedSize := oBody:IntOf("size")
IF (oBody:JsonTypeOf("attachmentId") == 1)
oUrl:SetString(oMessageUrl:GetAsString())
oUrl:Append("/attachments/")
oUrl:Append(oHttp:UrlEncode(oBody:StringOf("attachmentId")))
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()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
oBody: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()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
oBody:destroy()
RETURN
ENDIF
nSuccess := oReply:Load(oResp:BodyStr)
IF (nSuccess != 1)
? "Expected a Gmail JSON response."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
oBody:destroy()
RETURN
ENDIF
nSuccess := oReply:MakeCopy(oBody)
IF (nSuccess != 1)
? oReply:LastErrorText
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
oBody:destroy()
RETURN
ENDIF
ENDIF
IF (oBody:JsonTypeOf("data") != 1)
? "The attachment response has no data."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
oBody:destroy()
RETURN
ENDIF
oData := CreateObject("Chilkat.BinData")
IF (oBody:StringOfEquals("data", "", 1) != 1)
nSuccess := oBody:BytesOf("data", "base64url", oData)
IF (nSuccess != 1)
? oBody:LastErrorText
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
oBody:destroy()
oData:destroy()
RETURN
ENDIF
ENDIF
IF (oData:NumBytes != nExpectedSize)
? "Attachment size mismatch."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
oBody:destroy()
oData:destroy()
RETURN
ENDIF
nSuccess := oData:WriteFile("downloaded-attachment.bin")
IF (nSuccess != 1)
? "Could not save the attachment."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
oBody:destroy()
oData:destroy()
RETURN
ENDIF
? "Saved " + Str(oData:NumBytes) + " attachment bytes."
oToken:destroy()
oHttp:destroy()
oResp:destroy()
oReply:destroy()
oMessageUrl:destroy()
oUrl:destroy()
oPaths:destroy()
oPart:destroy()
oSelected:destroy()
oChildPath:destroy()
oBody:destroy()
oData:destroy()