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

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.

Google documentation

Note
This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.
JavaScript
var success = false;

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

var token = new CkJsonObject();
success = token.LoadFile("gmail-token.json");
if (success !== true) {
    console.log("Could not read gmail-token.json from the private working directory.");
    return;
}

if ((token.JsonTypeOf("access_token") !== 1) || (token.StringOfEquals("access_token","",true) == true)) {
    console.log("An OAuth access token is required.");
    return;
}

var http = new CkHttp();
http.RequireSslCertVerify = true;
http.AuthToken = token.StringOf("access_token");
var resp = new CkHttpResponse();
var reply = new CkJsonObject();
var messageId = "GMAIL_MESSAGE_ID";
var filename = "attachment.pdf";
var messageUrl = new CkStringBuilder();
messageUrl.Append("https://gmail.googleapis.com/gmail/v1/users/me/messages/");
messageUrl.Append(http.UrlEncode(messageId));
var url = new CkStringBuilder();
url.Append(messageUrl.GetAsString());
url.Append("?format=full");
success = http.HttpNoBody("GET",url.GetAsString(),resp);
if (resp.StatusCode == 0) {
    console.log("Gmail did not return an HTTP response.");
    return;
}

if ((success !== true) || (resp.StatusCode < 200) || (resp.StatusCode >= 300)) {
    console.log("Gmail HTTP " + resp.StatusCode);
    success = reply.Load(resp.BodyStr);
    if (success == true) {
        console.log(reply.StringOf("error.message"));
    }

    return;
}

success = reply.Load(resp.BodyStr);
if (success !== true) {
    console.log("Expected a Gmail JSON response.");
    return;
}

var paths = new CkStringTable();
success = paths.Append("payload");
if (success !== true) {
    console.log(paths.LastErrorText);
    return;
}

var part = new CkJsonObject();
var selected = new CkJsonObject();
var childPath = new CkStringBuilder();
var matches = 0;
var p = 0;
while ((p < paths.Count)) {
    success = reply.ObjectOf2(paths.StringAt(p),part);
    if (success !== true) {
        console.log(reply.LastErrorText);
        return;
    }

    if (part.StringOfEquals("filename",filename,true) == true) {
        matches = matches+1;
        success = part.MakeCopy(selected);
        if (success !== true) {
            console.log(part.LastErrorText);
            return;
        }

        console.log("Matching MIME part: " + paths.StringAt(p));
    }

    var 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) {
            console.log(paths.LastErrorText);
            return;
        }

        j = j+1;
    }

    p = p+1;
}

if (matches !== 1) {
    console.log("Expected one filename match. Matches: " + matches);
    return;
}

var body = new CkJsonObject();
success = selected.ObjectOf2("body",body);
if (success !== true) {
    console.log(selected.LastErrorText);
    return;
}

if (body.JsonTypeOf("size") !== 2) {
    console.log("The selected part has no byte count.");
    return;
}

var 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) {
        console.log("Gmail did not return an HTTP response.");
        return;
    }

    if ((success !== true) || (resp.StatusCode < 200) || (resp.StatusCode >= 300)) {
        console.log("Gmail HTTP " + resp.StatusCode);
        success = reply.Load(resp.BodyStr);
        if (success == true) {
            console.log(reply.StringOf("error.message"));
        }

        return;
    }

    success = reply.Load(resp.BodyStr);
    if (success !== true) {
        console.log("Expected a Gmail JSON response.");
        return;
    }

    success = reply.MakeCopy(body);
    if (success !== true) {
        console.log(reply.LastErrorText);
        return;
    }

}

if (body.JsonTypeOf("data") !== 1) {
    console.log("The attachment response has no data.");
    return;
}

var data = new CkBinData();
if (body.StringOfEquals("data","",true) !== true) {
    success = body.BytesOf("data","base64url",data);
    if (success !== true) {
        console.log(body.LastErrorText);
        return;
    }

}

if (data.NumBytes !== expectedSize) {
    console.log("Attachment size mismatch.");
    return;
}

success = data.WriteFile("downloaded-attachment.bin");
if (success !== true) {
    console.log("Could not save the attachment.");
    return;
}

console.log("Saved " + data.NumBytes + " attachment bytes.");