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 CkPython Downloads
import sys
import chilkat
success = False
# Assumes Chilkat is unlocked. See Global Unlock Sample.
token = chilkat.CkJsonObject()
success = token.LoadFile("gmail-token.json")
if (success != True):
print("Could not read gmail-token.json from the private working directory.")
sys.exit()
if ((token.JsonTypeOf("access_token") != 1) or (token.StringOfEquals("access_token","",True) == True)):
print("An OAuth access token is required.")
sys.exit()
http = chilkat.CkHttp()
http.put_RequireSslCertVerify(True)
http.put_AuthToken(token.stringOf("access_token"))
resp = chilkat.CkHttpResponse()
reply = chilkat.CkJsonObject()
messageId = "GMAIL_MESSAGE_ID"
filename = "attachment.pdf"
messageUrl = chilkat.CkStringBuilder()
messageUrl.Append("https://gmail.googleapis.com/gmail/v1/users/me/messages/")
messageUrl.Append(http.urlEncode(messageId))
url = chilkat.CkStringBuilder()
url.Append(messageUrl.getAsString())
url.Append("?format=full")
success = http.HttpNoBody("GET",url.getAsString(),resp)
if (resp.get_StatusCode() == 0):
print("Gmail did not return an HTTP response.")
sys.exit()
if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
print("Gmail HTTP " + str(resp.get_StatusCode()))
success = reply.Load(resp.bodyStr())
if (success == True):
print(reply.stringOf("error.message"))
sys.exit()
success = reply.Load(resp.bodyStr())
if (success != True):
print("Expected a Gmail JSON response.")
sys.exit()
paths = chilkat.CkStringTable()
success = paths.Append("payload")
if (success != True):
print(paths.lastErrorText())
sys.exit()
part = chilkat.CkJsonObject()
selected = chilkat.CkJsonObject()
childPath = chilkat.CkStringBuilder()
matches = 0
p = 0
while (p < paths.get_Count()) :
success = reply.ObjectOf2(paths.stringAt(p),part)
if (success != True):
print(reply.lastErrorText())
sys.exit()
if (part.StringOfEquals("filename",filename,True) == True):
matches = matches + 1
success = part.MakeCopy(selected)
if (success != True):
print(part.lastErrorText())
sys.exit()
print("Matching MIME part: " + paths.stringAt(p))
j = 0
while (j < part.SizeOfArray("parts")) :
childPath.SetString(paths.stringAt(p))
childPath.Append(".parts[")
childPath.AppendInt(j)
childPath.Append("]")
success = paths.Append(childPath.getAsString())
if (success != True):
print(paths.lastErrorText())
sys.exit()
j = j + 1
p = p + 1
if (matches != 1):
print("Expected one filename match. Matches: " + str(matches))
sys.exit()
body = chilkat.CkJsonObject()
success = selected.ObjectOf2("body",body)
if (success != True):
print(selected.lastErrorText())
sys.exit()
if (body.JsonTypeOf("size") != 2):
print("The selected part has no byte count.")
sys.exit()
expectedSize = body.IntOf("size")
if (body.JsonTypeOf("attachmentId") == 1):
url.SetString(messageUrl.getAsString())
url.Append("/attachments/")
url.Append(http.urlEncode(body.stringOf("attachmentId")))
success = http.HttpNoBody("GET",url.getAsString(),resp)
if (resp.get_StatusCode() == 0):
print("Gmail did not return an HTTP response.")
sys.exit()
if ((success != True) or (resp.get_StatusCode() < 200) or (resp.get_StatusCode() >= 300)):
print("Gmail HTTP " + str(resp.get_StatusCode()))
success = reply.Load(resp.bodyStr())
if (success == True):
print(reply.stringOf("error.message"))
sys.exit()
success = reply.Load(resp.bodyStr())
if (success != True):
print("Expected a Gmail JSON response.")
sys.exit()
success = reply.MakeCopy(body)
if (success != True):
print(reply.lastErrorText())
sys.exit()
if (body.JsonTypeOf("data") != 1):
print("The attachment response has no data.")
sys.exit()
data = chilkat.CkBinData()
if (body.StringOfEquals("data","",True) != True):
success = body.BytesOf("data","base64url",data)
if (success != True):
print(body.lastErrorText())
sys.exit()
if (data.get_NumBytes() != expectedSize):
print("Attachment size mismatch.")
sys.exit()
success = data.WriteFile("downloaded-attachment.bin")
if (success != True):
print("Could not save the attachment.")
sys.exit()
print("Saved " + str(data.get_NumBytes()) + " attachment bytes.")