Security News
CVE Volume Surges Past 48,000 in 2025 as WordPress Plugin Ecosystem Drives Growth
CVE disclosures hit a record 48,185 in 2025, driven largely by vulnerabilities in third-party WordPress plugins.
By Sarah Gooding - Jan 09, 2026
gmail-api-sync
Advanced tools
gmail-api-sync
Sync, query and parse Gmail e-mails with Google API. Provides full and partial e-mail synchronization, as well as parsing the returned message objects into text and html. Takes care of Google Oauth 2 authentication with convenience methods.
gmail-api-sync
Sync, query and parse Gmail e-mails with Google API.
Provides full and partial e-mail synchronization, as well as parsing the returned message objects into text and html. Takes care of Google Oauth 2 authentication with convenience methods.
Installation
#install and save
npm install gmail-api-sync --save
Usage
Require the module.
var gmailApiSync = require('gmail-api-sync');
Load Google Api Project client secret. To get this file follow Step 1 .
gmailApiSync.setClientSecretsFile('./client_secret.json');
Full Synchronization (Requires Oauth2 authentication see below)
Query all e-mails (e.g. from:facebook.com, newer_than:2d, before:2017/04/18). See all posible queries Search operators you can use with Gmail
var options = {query: 'from:facebook.com'};
gmailApiSync.queryMessages(oauth, options, function (err, response) {
if (!err) {
console.log(JSON.stringify(response));
// {
// "emails": [
// {
// "id": "15a863bf55605f13",
// "date": "Tue, 28 Feb 2017 11:39:20 -0800",
// "from": "Facebook Analytics for Apps <analyticsforapps-noreply@facebook.com>",
// "subject": "New from Facebook Analytics for Apps",
// "textHtml": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional //EN\"><html><head><title>Facebook</title><meta http-equiv=
// \"Content-Type\" content=\"text/html; charset=utf-8\" /><style>@media all and (max-width: 480px){*[class].ib_t{min-width:100% !important}*[clas (...)",
// "textPlain": "Hi Juan,\r\n\r\nFacebook Analytics for Apps Hits 1 Million Apps, Websites, Bots and Adds New Features\r\n\r\nWe're so (...)",
// "historyId": "13855"
// }
// ],
// "historyId": "13855"
// }
});
Partial Synchronization (Requires Oauth2 authentication see below)
Sync e-mail changes with historyId from last message retrieved. For more information on historyId see Partial synchronization
var options = {historyId: previousResponse.historyId}; //previousResponse.historyId: "13855"
gmailApiSync.syncMessages(oauth, options, function (err, response) {
if (!err) {
console.log(JSON.stringify(response));
// {
// "emails": [ {
// "id": "15b87edac93971d1",
// "date": "Wed, 19 Apr 2017 13:35:50 -0700",
// "from": "Facebook <notification+kjdvmpu51uu_@facebookmail.com>",
// "subject": "Juan, you have 67 new notifications",
// "textHtml": "<!DOCTYPE HTML PUBLIC \"-//W3C//DTD HTML 4.01 Transitional //EN\"><html><head><title>Facebook</title><meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\" /><style>@media all and (max-width: 480px){*[class].ib_t{min-width:100% !important}*[class].ib_row{display:block !important}*
// "textPlain": "========================================\r\nGo to Facebook\r\nhttps://www.facebook.com/n/?
// "historyId": "15424"
// }
// ],
// "historyId": "15424"
// }
}
});
Authentication with Access Token
This assumes you already have an access token from Google Api. To get one, see test Generate Access Token .
gmailApiSync.authorizeWithToken(accessToken, function (err, oauth) {
});
Authentication with ServerAuth Code
This assumes you already have a ServerAuth Code from Google Api. To get one, see test Generate Server Auth code .
gmailApiSync.authorizeWithServerAuth(serverAuthCode, function (err, oauth) {
});
Reponse Format
The returned e-mails can be formated in the following modes if specified in the options param:
- list: Returns the most basic format including just the messageId and threadId.
- metadata: Returns all the message headers but no body (textHtml or textPlain).
- raw: Returns the full email message data with body content in the raw field as a base64url encoded string.
- full (default): Returns a fully parsed message including all headers and decoded body (textHtml and/or textPlain).
var options = {
query: 'subject:"Claim your free iPhone"',
format: 'metadata'
}
Full working example
var gmailApiSync = require('gmail-api-sync');
gmailApiSync.setClientSecretsFile('./client_secret.json');
var options = {
query: 'from:*.org',
format: 'metadata'
}
gmailApiSync.authorizeWithToken(accessToken, function (err, oauth) {
if (err) {
console.log('Something went wrong: ' + err);
return;
}
else {
gmailApiSync.queryMessages(oauth, options, function (err, response) {
if (err) {
console.log('Something went wrong: ' + err);
return;
}
console.log(JSON.stringify(response));
});
}
});
FAQs
Sync, query and parse Gmail e-mails with Google API. Provides full and partial e-mail synchronization, as well as parsing the returned message objects into text and html. Takes care of Google Oauth 2 authentication with convenience methods.
The npm package gmail-api-sync receives a total of 6 weekly downloads. As such, gmail-api-sync popularity was classified as not popular.
We found that gmail-api-sync demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Package last updated on 21 Apr 2017
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Related posts
Security News
Insecure Agents Podcast: Certified Patches, Supply Chain Security, and AI Agents
Socket CEO Feross Aboukhadijeh joins Insecure Agents to discuss CVE remediation and why supply chain attacks require a different security approach.
By Sarah Gooding - Jan 08, 2026
Security News
Tailwind CSS Announces 75% Layoffs as LLMs Reshape OSS Business Models
Tailwind Labs laid off 75% of its engineering team after revenue dropped 80%, as LLMs redirect traffic away from documentation where developers discover paid products.
By Sarah Gooding - Jan 08, 2026