Sample code for 30+ languages & platforms
CkPerl 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

Chilkat CkPerl Downloads

CkPerl
use chilkat();

$success = 0;

#  Assumes Chilkat is unlocked. See Global Unlock Sample.

$token = chilkat::CkJsonObject->new();
$success = $token->LoadFile("gmail-token.json");
if ($success != 1) {
    print "Could not read gmail-token.json from the private working directory." . "\r\n";
    exit;
}

if (($token->JsonTypeOf("access_token") != 1) or ($token->StringOfEquals("access_token","",1) == 1)) {
    print "An OAuth access token is required." . "\r\n";
    exit;
}

$http = chilkat::CkHttp->new();
$http->put_RequireSslCertVerify(1);
$http->put_AuthToken($token->stringOf("access_token"));
$resp = chilkat::CkHttpResponse->new();
$reply = chilkat::CkJsonObject->new();
$messageId = "GMAIL_MESSAGE_ID";
$filename = "attachment.pdf";
$messageUrl = chilkat::CkStringBuilder->new();
$messageUrl->Append("https://gmail.googleapis.com/gmail/v1/users/me/messages/");
$messageUrl->Append($http->urlEncode($messageId));
$url = chilkat::CkStringBuilder->new();
$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." . "\r\n";
    exit;
}

if (($success != 1) or ($resp->get_StatusCode() < 200) or ($resp->get_StatusCode() >= 300)) {
    print "Gmail HTTP " . $resp->get_StatusCode() . "\r\n";
    $success = $reply->Load($resp->bodyStr());
    if ($success == 1) {
        print $reply->stringOf("error.message") . "\r\n";
    }

    exit;
}

$success = $reply->Load($resp->bodyStr());
if ($success != 1) {
    print "Expected a Gmail JSON response." . "\r\n";
    exit;
}

$paths = chilkat::CkStringTable->new();
$success = $paths->Append("payload");
if ($success != 1) {
    print $paths->lastErrorText() . "\r\n";
    exit;
}

$part = chilkat::CkJsonObject->new();
$selected = chilkat::CkJsonObject->new();
$childPath = chilkat::CkStringBuilder->new();
$matches = 0;
$p = 0;
while (($p < $paths->get_Count())) {
    $success = $reply->ObjectOf2($paths->stringAt($p),$part);
    if ($success != 1) {
        print $reply->lastErrorText() . "\r\n";
        exit;
    }

    if ($part->StringOfEquals("filename",$filename,1) == 1) {
        $matches = $matches + 1;
        $success = $part->MakeCopy($selected);
        if ($success != 1) {
            print $part->lastErrorText() . "\r\n";
            exit;
        }

        print "Matching MIME part: " . $paths->stringAt($p) . "\r\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() . "\r\n";
            exit;
        }

        $j = $j + 1;
    }

    $p = $p + 1;
}

if ($matches != 1) {
    print "Expected one filename match. Matches: " . $matches . "\r\n";
    exit;
}

$body = chilkat::CkJsonObject->new();
$success = $selected->ObjectOf2("body",$body);
if ($success != 1) {
    print $selected->lastErrorText() . "\r\n";
    exit;
}

if ($body->JsonTypeOf("size") != 2) {
    print "The selected part has no byte count." . "\r\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->get_StatusCode() == 0) {
        print "Gmail did not return an HTTP response." . "\r\n";
        exit;
    }

    if (($success != 1) or ($resp->get_StatusCode() < 200) or ($resp->get_StatusCode() >= 300)) {
        print "Gmail HTTP " . $resp->get_StatusCode() . "\r\n";
        $success = $reply->Load($resp->bodyStr());
        if ($success == 1) {
            print $reply->stringOf("error.message") . "\r\n";
        }

        exit;
    }

    $success = $reply->Load($resp->bodyStr());
    if ($success != 1) {
        print "Expected a Gmail JSON response." . "\r\n";
        exit;
    }

    $success = $reply->MakeCopy($body);
    if ($success != 1) {
        print $reply->lastErrorText() . "\r\n";
        exit;
    }

}

if ($body->JsonTypeOf("data") != 1) {
    print "The attachment response has no data." . "\r\n";
    exit;
}

$data = chilkat::CkBinData->new();
if ($body->StringOfEquals("data","",1) != 1) {
    $success = $body->BytesOf("data","base64url",$data);
    if ($success != 1) {
        print $body->lastErrorText() . "\r\n";
        exit;
    }

}

if ($data->get_NumBytes() != $expectedSize) {
    print "Attachment size mismatch." . "\r\n";
    exit;
}

$success = $data->WriteFile("downloaded-attachment.bin");
if ($success != 1) {
    print "Could not save the attachment." . "\r\n";
    exit;
}

print "Saved " . $data->get_NumBytes() . " attachment bytes." . "\r\n";