gmail-api-sync
Advanced tools
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.
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.
#install and save
npm install gmail-api-sync --save
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');
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 newer_than:2d'};
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"
// }
});
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"
// }
}
});
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) {
});
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) {
});
~/personal/gmail-api-sync/test$ node generate_server_auth.js
Authorize this app by visiting this url: https://accounts.google.com/o/oauth2/auth?access_type=offline&scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fgmail.compose&response_type=code&client_id=1081826302113-deknk5sgd6n2vutgv3l4ub4530qqc8kh.apps.googleusercontent.com&redirect_uri=urn%3Aietf%3Awg%3Aoauth%3A2.0%3Aoob
If you need a accessToken to be generated as well, run:
node generate_access_token <SERVER_AUTH_CODE>, with the code you received from the visited URL.
~/personal/gmail-api-sync/test$ node generate_access_token.js 4/AR34xAC0Z437ItI_27FmpDYmCeNMpMWNyZk0G6cV6EQ
token: {"access_token":"ya29.Gls0BCt9gHK7Bmn5mPQFff6JCaVyt8ZcRiUgLPQL4SmAFk-msJOTIaISi-UiPhRD7QHR2n_8dJXymn08helwDCcnHpGK14sqHXhsH3fgTlvaNz1dZbA7P6LJO4BH","refresh_token":"1/kVLTLeR7vb1e6tuT6XHWBqZ0nG-qwldfeO1uhwdwBok","token_type":"Bearer","expiry_date":1492885695675}
The returned e-mails can be formated in the following modes if specified in the options param:
var options = {
query: 'subject:"Claim your free iPhone"',
format: 'metadata'
}
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 21 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.
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.
Research
Node.js patched a crash bug where AsyncLocalStorage could cause stack overflows to bypass error handlers and terminate production servers.
Research
/Security News
A malicious Chrome extension steals newly created MEXC API keys, exfiltrates them to Telegram, and enables full account takeover with trading and withdrawal rights.
Security News
CVE disclosures hit a record 48,185 in 2025, driven largely by vulnerabilities in third-party WordPress plugins.