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 PHP ActiveX Downloads
<?php
$success = 0;
// Assumes Chilkat is unlocked. See Global Unlock Sample.
$token = new COM("Chilkat.JsonObject");
$success = $token->LoadFile('gmail-token.json');
if ($success != 1) {
print 'Could not read gmail-token.json from the private working directory.' . "\n";
exit;
}
if (($token->JsonTypeOf('access_token') != 1) or ($token->StringOfEquals('access_token','',1) == 1)) {
print 'An OAuth access token is required.' . "\n";
exit;
}
$http = new COM("Chilkat.Http");
$http->RequireSslCertVerify = 1;
$http->AuthToken = $token->stringOf('access_token');
$resp = new COM("Chilkat.HttpResponse");
$reply = new COM("Chilkat.JsonObject");
$messageId = 'GMAIL_MESSAGE_ID';
$filename = 'attachment.pdf';
$messageUrl = new COM("Chilkat.StringBuilder");
$messageUrl->Append('https://gmail.googleapis.com/gmail/v1/users/me/messages/');
$messageUrl->Append($http->urlEncode($messageId));
$url = new COM("Chilkat.StringBuilder");
$url->Append($messageUrl->getAsString());
$url->Append('?format=full');
$success = $http->HttpNoBody('GET',$url->getAsString(),$resp);
if ($resp->StatusCode == 0) {
print 'Gmail did not return an HTTP response.' . "\n";
exit;
}
if (($success != 1) or ($resp->StatusCode < 200) or ($resp->StatusCode >= 300)) {
print 'Gmail HTTP ' . $resp->StatusCode . "\n";
$success = $reply->Load($resp->BodyStr);
if ($success == 1) {
print $reply->stringOf('error.message') . "\n";
}
exit;
}
$success = $reply->Load($resp->BodyStr);
if ($success != 1) {
print 'Expected a Gmail JSON response.' . "\n";
exit;
}
$paths = new COM("Chilkat.StringTable");
$success = $paths->Append('payload');
if ($success != 1) {
print $paths->LastErrorText . "\n";
exit;
}
$part = new COM("Chilkat.JsonObject");
$selected = new COM("Chilkat.JsonObject");
$childPath = new COM("Chilkat.StringBuilder");
$matches = 0;
$p = 0;
while (($p < $paths->Count)) {
$success = $reply->ObjectOf2($paths->stringAt($p),$part);
if ($success != 1) {
print $reply->LastErrorText . "\n";
exit;
}
if ($part->StringOfEquals('filename',$filename,1) == 1) {
$matches = $matches + 1;
$success = $part->MakeCopy($selected);
if ($success != 1) {
print $part->LastErrorText . "\n";
exit;
}
print 'Matching MIME part: ' . $paths->stringAt($p) . "\n";
}
$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 != 1) {
print $paths->LastErrorText . "\n";
exit;
}
$j = $j + 1;
}
$p = $p + 1;
}
if ($matches != 1) {
print 'Expected one filename match. Matches: ' . $matches . "\n";
exit;
}
$body = new COM("Chilkat.JsonObject");
$success = $selected->ObjectOf2('body',$body);
if ($success != 1) {
print $selected->LastErrorText . "\n";
exit;
}
if ($body->JsonTypeOf('size') != 2) {
print 'The selected part has no byte count.' . "\n";
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->StatusCode == 0) {
print 'Gmail did not return an HTTP response.' . "\n";
exit;
}
if (($success != 1) or ($resp->StatusCode < 200) or ($resp->StatusCode >= 300)) {
print 'Gmail HTTP ' . $resp->StatusCode . "\n";
$success = $reply->Load($resp->BodyStr);
if ($success == 1) {
print $reply->stringOf('error.message') . "\n";
}
exit;
}
$success = $reply->Load($resp->BodyStr);
if ($success != 1) {
print 'Expected a Gmail JSON response.' . "\n";
exit;
}
$success = $reply->MakeCopy($body);
if ($success != 1) {
print $reply->LastErrorText . "\n";
exit;
}
}
if ($body->JsonTypeOf('data') != 1) {
print 'The attachment response has no data.' . "\n";
exit;
}
$data = new COM("Chilkat.BinData");
if ($body->StringOfEquals('data','',1) != 1) {
$success = $body->BytesOf('data','base64url',$data);
if ($success != 1) {
print $body->LastErrorText . "\n";
exit;
}
}
if ($data->NumBytes != $expectedSize) {
print 'Attachment size mismatch.' . "\n";
exit;
}
$success = $data->WriteFile('downloaded-attachment.bin');
if ($success != 1) {
print 'Could not save the attachment.' . "\n";
exit;
}
print 'Saved ' . $data->NumBytes . ' attachment bytes.' . "\n";
?>