├── .cirrus.yml ├── .gcloudignore ├── .gitignore ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── config.js ├── config.json ├── index.js ├── lib ├── helpers.js └── oauth.js ├── package-lock.json ├── package.json ├── renovate.json └── test.js /.cirrus.yml: -------------------------------------------------------------------------------- 1 | container: 2 | image: node:10 3 | 4 | lint_task: 5 | install_script: npm install 6 | test_script: npm run lint 7 | 8 | test_task: 9 | container: 10 | matrix: 11 | image: node:12 12 | image: node:10 13 | image: node:8 14 | install_script: npm install 15 | test_script: npm test 16 | -------------------------------------------------------------------------------- /.gcloudignore: -------------------------------------------------------------------------------- 1 | # This file specifies files that are *not* uploaded to Google Cloud Platform 2 | # using gcloud. It follows the same syntax as .gitignore, with the addition of 3 | # "#!include" directives (which insert the entries of the given .gitignore-style 4 | # file at that point). 5 | # 6 | # For more information, run: 7 | # $ gcloud topic gcloudignore 8 | # 9 | .gcloudignore 10 | # If you would like to upload your .git directory, .gitignore file or files 11 | # from your .gitignore file, remove the corresponding line 12 | # below: 13 | .git 14 | .gitignore 15 | 16 | node_modules 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | client_secret.json 3 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to become a contributor and submit your own code 2 | 3 | ## Contributor License Agreements 4 | 5 | We'd love to accept your sample apps and patches! Before we can take them, we 6 | have to jump a couple of legal hurdles. 7 | 8 | Please fill out either the individual or corporate Contributor License Agreement 9 | (CLA). 10 | 11 | * If you are an individual writing original source code and you're sure you 12 | own the intellectual property, then you'll need to sign an 13 | [individual CLA](https://developers.google.com/open-source/cla/individual). 14 | * If you work for a company that wants to allow you to contribute your work, 15 | then you'll need to sign a 16 | [corporate CLA](https://developers.google.com/open-source/cla/corporate). 17 | 18 | Follow either of the two links above to access the appropriate CLA and 19 | instructions for how to sign and return it. Once we receive it, we'll be able to 20 | accept your pull requests. 21 | 22 | ## Style 23 | 24 | Samples in this repository follow the [JavaScript Semi-Standard 25 | Style](https://github.com/Flet/semistandard). 26 | 27 | You can run `semistandard` to match our JavaScript coding standards. -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Gmail + GCF intelligence demo 2 | 3 | This repository demonstrates how to write custom mail processing logic for Gmail using the [Gmail API][gmail] and [Cloud Functions][gcf]. See the [blog post][blog] for more information. 4 | 5 | ## Obtaining an OAuth 2.0 Client ID 6 | In order for an OAuth 2.0 API to verify our program's identity, we must include 7 | an _OAuth 2.0 client ID_ with some of our requests to the API. The following 8 | steps show how to enable the Gmail API and download the client ID to your local 9 | machine. 10 | 11 | 1. Enable the Gmail API using the [the Gmail API page in the GCP Console][console_gmail]. 12 | 1. Find the [GCP region][docs_regions] you want to deploy your function to. 13 | (In general, response time is quickest for the regions closest to you.) For 14 | the rest of this tutorial, replace `[YOUR_GCF_REGION]` with your selected 15 | region's name (for example, `us-central1`). 16 | 1. Generate a new OAuth 2.0 client ID by [visiting the GCP Console credentials page][console_credentials]. 17 | Configure the fields as indicated below: 18 | 19 | - Application type: `Web application` 20 | - Name: an appropriate, memorable name for your client 21 | - Authorized redirect URIs: `https://[YOUR_GCF_REGION]-[YOUR_GCP_PROJECT_ID].cloudfunctions.net/oauth2callback` 22 | 23 | 1. Click _Create_, then close the resulting dialog box and click the 24 | **Download** icon next to your newly created client ID. The resulting file 25 | is your __Client Secret file__. 26 | 27 | ## Configuring local files 28 | 1. Rename your __Client Secret file__ to `client_secret.json`, and move it to 29 | the directory that contains your `index.js` and `package.json` files. 30 | 1. In `config.json`, update the values for `GCF_REGION`, `GCLOUD_PROJECT`, 31 | and `TOPIC_ID`. 32 | 33 | [blog]: https://cloud.google.com/blog/products/application-development/adding-custom-intelligence-to-gmail-with-serverless-on-gcp 34 | [docs_regions]: http://cloud.google.com/functions/docs/locations 35 | [console_gmail]: http://console.cloud.google.com/apis/api/gmail.googleapis.com/overview 36 | [console_credentials]: https://console.cloud.google.com/apis/credentials 37 | [gmail]: https://developers.google.com/gmail/api 38 | [gcf]: https://cloud.google.com/functions 39 | -------------------------------------------------------------------------------- /config.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2018, Google LLC 3 | * Licensed under the Apache License, Version 2.0 (the "License"); 4 | * you may not use this file except in compliance with the License. 5 | * You may obtain a copy of the License at 6 | * 7 | * http://www.apache.org/licenses/LICENSE-2.0 8 | * 9 | * Unless required by applicable law or agreed to in writing, software 10 | * distributed under the License is distributed on an "AS IS" BASIS, 11 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | * See the License for the specific language governing permissions and 13 | * limitations under the License. 14 | */ 15 | 16 | const nconf = require('nconf'); 17 | 18 | nconf.env() 19 | .file({ file: 'config.json' }); 20 | 21 | // Configuration constants 22 | const GCF_REGION = nconf.get('GCF_REGION'); 23 | const GCLOUD_PROJECT = nconf.get('GCLOUD_PROJECT'); 24 | const TOPIC_ID = nconf.get('TOPIC_ID'); 25 | 26 | // Computed values 27 | exports.GCF_BASE_URL = `https://${GCF_REGION}-${GCLOUD_PROJECT}.cloudfunctions.net`; 28 | exports.TOPIC_NAME = `projects/${GCLOUD_PROJECT}/topics/${TOPIC_ID}`; 29 | exports.GCF_REGION = GCF_REGION; 30 | 31 | // Constants 32 | exports.NO_LABEL_MATCH = 'Message doesn\'t match label'; 33 | exports.UNKNOWN_USER_MESSAGE = 'Uninitialized email address'; 34 | -------------------------------------------------------------------------------- /config.json: -------------------------------------------------------------------------------- 1 | { 2 | "GCF_REGION": "YOUR_GCF_REGION", 3 | "GCLOUD_PROJECT": "YOUR_GCLOUD_PROJECT_ID", 4 | "TOPIC_ID": "YOUR_PUBSUB_TOPIC" 5 | } -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2018, Google LLC 3 | * Licensed under the Apache License, Version 2.0 (the "License"); 4 | * you may not use this file except in compliance with the License. 5 | * You may obtain a copy of the License at 6 | * 7 | * http://www.apache.org/licenses/LICENSE-2.0 8 | * 9 | * Unless required by applicable law or agreed to in writing, software 10 | * distributed under the License is distributed on an "AS IS" BASIS, 11 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | * See the License for the specific language governing permissions and 13 | * limitations under the License. 14 | */ 15 | 16 | 'use strict'; 17 | 18 | const google = require('googleapis'); 19 | const gmail = google.gmail('v1'); 20 | const querystring = require('querystring'); 21 | const pify = require('pify'); 22 | const config = require('./config'); 23 | const oauth = require('./lib/oauth'); 24 | const helpers = require('./lib/helpers'); 25 | 26 | /** 27 | * Request an OAuth 2.0 authorization code 28 | * Only new users (or those who want to refresh 29 | * their auth data) need visit this page 30 | */ 31 | exports.oauth2init = (req, res) => { 32 | // Define OAuth2 scopes 33 | const scopes = [ 34 | 'https://www.googleapis.com/auth/gmail.modify' 35 | ]; 36 | 37 | // Generate + redirect to OAuth2 consent form URL 38 | const authUrl = oauth.client.generateAuthUrl({ 39 | access_type: 'offline', 40 | scope: scopes, 41 | prompt: 'consent' // Required in order to receive a refresh token every time 42 | }); 43 | return res.redirect(authUrl); 44 | }; 45 | 46 | /** 47 | * Get an access token from the authorization code and store token in Datastore 48 | */ 49 | exports.oauth2callback = (req, res) => { 50 | // Get authorization code from request 51 | const code = req.query.code; 52 | 53 | // OAuth2: Exchange authorization code for access token 54 | return new Promise((resolve, reject) => { 55 | oauth.client.getToken(code, (err, token) => 56 | (err ? reject(err) : resolve(token)) 57 | ); 58 | }) 59 | .then((token) => { 60 | // Get user email (to use as a Datastore key) 61 | oauth.client.credentials = token; 62 | return Promise.all([token, oauth.getEmailAddress()]); 63 | }) 64 | .then(([token, emailAddress]) => { 65 | // Store token in Datastore 66 | return Promise.all([ 67 | emailAddress, 68 | oauth.saveToken(emailAddress) 69 | ]); 70 | }) 71 | .then(([emailAddress]) => { 72 | // Respond to request 73 | res.redirect(`/initWatch?emailAddress=${querystring.escape(emailAddress)}`); 74 | }) 75 | .catch((err) => { 76 | // Handle error 77 | console.error(err); 78 | res.status(500).send('Something went wrong; check the logs.'); 79 | }); 80 | }; 81 | 82 | /** 83 | * Initialize a watch on the user's inbox 84 | */ 85 | exports.initWatch = (req, res) => { 86 | // Require a valid email address 87 | if (!req.query.emailAddress) { 88 | return res.status(400).send('No emailAddress specified.'); 89 | } 90 | const email = querystring.unescape(req.query.emailAddress); 91 | if (!email.includes('@')) { 92 | return res.status(400).send('Invalid emailAddress.'); 93 | } 94 | 95 | // Retrieve the stored OAuth 2.0 access token 96 | return oauth.fetchToken(email) 97 | .then(() => { 98 | // Initialize a watch 99 | return pify(gmail.users.watch)({ 100 | auth: oauth.client, 101 | userId: 'me', 102 | resource: { 103 | labelIds: ['INBOX'], 104 | topicName: config.TOPIC_NAME 105 | } 106 | }); 107 | }) 108 | .then(() => { 109 | // Respond with status 110 | res.write('Watch initialized!'); 111 | res.status(200).end(); 112 | }) 113 | .catch((err) => { 114 | // Handle errors 115 | if (err.message === config.UNKNOWN_USER_MESSAGE) { 116 | res.redirect('/oauth2init'); 117 | } else { 118 | console.error(err); 119 | res.status(500).send('Something went wrong; check the logs.'); 120 | } 121 | }); 122 | }; 123 | 124 | /** 125 | * Process new messages as they are received 126 | */ 127 | exports.onNewMessage = (event) => { 128 | // Parse the Pub/Sub message 129 | const dataStr = Buffer.from(event.data.data, 'base64').toString('ascii'); 130 | const dataObj = JSON.parse(dataStr); 131 | 132 | return oauth.fetchToken(dataObj.emailAddress) 133 | .then(helpers.listMessageIds) 134 | .then(res => helpers.getMessageById(res.messages[0].id)) // Most recent message 135 | .then(msg => Promise.all([msg, helpers.getAllImages(msg)])) 136 | .then(([msg, images]) => Promise.all([msg, helpers.getImageLabels(images)])) 137 | .then(([msg, labels]) => { 138 | if (!labels.includes('bird')) { 139 | throw new Error(config.NO_LABEL_MATCH); // Exit promise chain 140 | } 141 | 142 | return helpers.labelMessage(msg.id, ['STARRED']); 143 | }) 144 | .catch((err) => { 145 | // Handle unexpected errors 146 | if (!err.message || err.message !== config.NO_LABEL_MATCH) { 147 | console.error(err); 148 | } 149 | }); 150 | }; 151 | -------------------------------------------------------------------------------- /lib/helpers.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2018, Google LLC 3 | * Licensed under the Apache License, Version 2.0 (the "License"); 4 | * you may not use this file except in compliance with the License. 5 | * You may obtain a copy of the License at 6 | * 7 | * http://www.apache.org/licenses/LICENSE-2.0 8 | * 9 | * Unless required by applicable law or agreed to in writing, software 10 | * distributed under the License is distributed on an "AS IS" BASIS, 11 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | * See the License for the specific language governing permissions and 13 | * limitations under the License. 14 | */ 15 | 16 | 'use strict'; 17 | 18 | const cheerio = require('cheerio'); 19 | const google = require('googleapis'); 20 | const gmail = google.gmail('v1'); 21 | const oauth = require('./oauth'); 22 | const pify = require('pify'); 23 | const Vision = require('@google-cloud/vision'); 24 | const visionClient = new Vision.ImageAnnotatorClient(); 25 | 26 | /** 27 | * Get base64-encoded image attachments in a GMail message 28 | * @param message The GMail message to extract images from 29 | * @returns A promise containing a list of base64-encoded images 30 | */ 31 | const _getImageAttachments = (message) => { 32 | // Get attachment data 33 | const attachmentIds = message.payload.parts 34 | .filter(x => x.mimeType && x.mimeType.includes('image')) 35 | .map(x => x.body.attachmentId); 36 | 37 | // Return base64-encoded images 38 | return Promise.all(attachmentIds.map(attachmentId => { 39 | return pify(gmail.users.messages.attachments.get)({ 40 | auth: oauth.client, 41 | userId: 'me', 42 | id: attachmentId, 43 | messageId: message.id 44 | }).then(result => { 45 | // Convert from base64url to base64 46 | const imageData = result.data.replace(/-/g, '+').replace(/_/g, '/'); 47 | return Buffer.from(imageData, 'base64'); 48 | }); 49 | })); 50 | }; 51 | 52 | /** 53 | * Get URL-referenced images in a GMail message 54 | * @param message The GMail message to extract images from 55 | * @returns A list of image URLs 56 | */ 57 | const _getImageUrls = (message) => { 58 | const unpack = (x) => { 59 | return Buffer.from(x.body.data || '', 'base64').toString(); 60 | }; 61 | 62 | // Get message's HTML 63 | let rawHtml = message.payload.parts.map( 64 | p => unpack(p) 65 | ).join(''); 66 | rawHtml += unpack(message.payload); 67 | 68 | // Return image URLs 69 | return cheerio.load(rawHtml)('img') 70 | .toArray() 71 | .map(image => image.attribs.src); 72 | }; 73 | 74 | /** 75 | * Get all images from a GMail message 76 | * @param message The GMail message to extract images from 77 | * @returns A promise containing a list of {image URLs, base64-encoded images} 78 | */ 79 | exports.getAllImages = (msg) => { 80 | const urlImages = _getImageUrls(msg); 81 | const base64Images = _getImageAttachments(msg); 82 | return Promise.all([urlImages, base64Images]) 83 | .then(([urlImages, base64Images]) => urlImages.concat(base64Images)); 84 | }; 85 | 86 | /** 87 | * List GMail message IDs 88 | * @returns A promise containing a list of GMail message IDs 89 | */ 90 | exports.listMessageIds = () => { 91 | return pify(gmail.users.messages.list)( 92 | { auth: oauth.client, userId: 'me' } 93 | ); 94 | }; 95 | 96 | /** 97 | * Get a GMail message given a message ID 98 | * @param messageId The ID of the message to get 99 | * @returns A promise containing the specified GMail message 100 | */ 101 | exports.getMessageById = (messageId) => { 102 | return pify(gmail.users.messages.get)({ 103 | auth: oauth.client, 104 | id: messageId, 105 | userId: 'me' 106 | }); 107 | }; 108 | 109 | /** 110 | * Label a GMail message 111 | * @param messageId The ID of the message to label 112 | * @param labels The labels to apply to the message 113 | */ 114 | exports.labelMessage = (messageId, labels) => { 115 | return pify(gmail.users.messages.modify)({ 116 | auth: oauth.client, 117 | id: messageId, 118 | userId: 'me', 119 | resource: { 120 | addLabelIds: labels 121 | } 122 | }); 123 | }; 124 | 125 | /** 126 | * Get labels for a series of images 127 | * @param images A list of {base64-encoded images, image URLs} to label 128 | * @param returns A flattened list of labels for the specified images 129 | */ 130 | exports.getImageLabels = (images) => { 131 | // Get labels for each images 132 | const requests = images.map(image => visionClient.labelDetection(image)); 133 | 134 | return Promise.all(requests) 135 | .then(results => { 136 | // Propagate request errors (to be caught elsewhere) 137 | if (results[0].error) { 138 | throw new Error(results[0].error); 139 | } 140 | 141 | // Map to label array-of-arrays 142 | return results.map(result => 143 | result[0].labelAnnotations.map(label => label.description) 144 | ); 145 | }) 146 | .then(labelSet => { 147 | // Flatten labelSet 148 | return labelSet.reduce((x, y) => x.concat(y), []); 149 | }); 150 | }; 151 | -------------------------------------------------------------------------------- /lib/oauth.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2018, Google LLC 3 | * Licensed under the Apache License, Version 2.0 (the "License"); 4 | * you may not use this file except in compliance with the License. 5 | * You may obtain a copy of the License at 6 | * 7 | * http://www.apache.org/licenses/LICENSE-2.0 8 | * 9 | * Unless required by applicable law or agreed to in writing, software 10 | * distributed under the License is distributed on an "AS IS" BASIS, 11 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | * See the License for the specific language governing permissions and 13 | * limitations under the License. 14 | */ 15 | 16 | 'use strict'; 17 | 18 | const config = require('../config'); 19 | const Datastore = require('@google-cloud/datastore'); 20 | const datastore = new Datastore(); 21 | const path = require('path'); 22 | const pify = require('pify'); 23 | const fs = require('fs'); 24 | const google = require('googleapis'); 25 | const gmail = google.gmail('v1'); 26 | 27 | // Retrieve OAuth2 config 28 | const clientSecretPath = path.join(path.dirname(__dirname), 'client_secret.json'); 29 | const clientSecretJson = JSON.parse(fs.readFileSync(clientSecretPath)); 30 | const oauth2Client = new google.auth.OAuth2( 31 | clientSecretJson.web.client_id, 32 | clientSecretJson.web.client_secret, 33 | `${config.GCF_BASE_URL}/oauth2callback` 34 | ); 35 | exports.client = oauth2Client; 36 | 37 | /** 38 | * Helper function to get the current user's email address 39 | */ 40 | exports.getEmailAddress = (t) => { 41 | return pify(gmail.users.getProfile)({ 42 | auth: oauth2Client, 43 | userId: 'me' 44 | }).then(x => x.emailAddress); 45 | }; 46 | 47 | /** 48 | * Helper function to fetch a user's OAuth 2.0 access token 49 | * Can fetch current tokens from Datastore, or create new ones 50 | */ 51 | exports.fetchToken = (emailAddress) => { 52 | return datastore.get(datastore.key(['oauth2Token', emailAddress])) 53 | .then((tokens) => { 54 | const token = tokens[0]; 55 | 56 | // Check for new users 57 | if (!token) { 58 | throw new Error(config.UNKNOWN_USER_MESSAGE); 59 | } 60 | 61 | // Validate token 62 | if (!token.expiry_date || token.expiry_date < Date.now() + 60000) { 63 | oauth2Client.credentials.refresh_token = 64 | oauth2Client.credentials.refresh_token || token.refresh_token; 65 | return new Promise((resolve, reject) => { // Pify and oauth2client don't mix 66 | oauth2Client.refreshAccessToken((err, response) => { 67 | if (err) { 68 | return reject(err); 69 | } 70 | return resolve(); 71 | }); 72 | }) 73 | .then(() => { 74 | return exports.saveToken(emailAddress); 75 | }); 76 | } else { 77 | oauth2Client.credentials = token; 78 | return Promise.resolve(); 79 | } 80 | }); 81 | }; 82 | 83 | /** 84 | * Helper function to save an OAuth 2.0 access token to Datastore 85 | */ 86 | exports.saveToken = (emailAddress) => { 87 | return datastore.save({ 88 | key: datastore.key(['oauth2Token', emailAddress]), 89 | data: oauth2Client.credentials 90 | }); 91 | }; 92 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "community-gcf-oauth", 3 | "version": "0.0.1", 4 | "private": true, 5 | "license": "Apache-2.0", 6 | "author": "Google LLC", 7 | "repository": { 8 | "type": "git", 9 | "url": "https://github.com/GoogleCloudPlatform/cloud-functions-gmail-nodejs.git" 10 | }, 11 | "engines": { 12 | "node": ">=8.13.0" 13 | }, 14 | "scripts": { 15 | "fix": "semistandard --fix", 16 | "lint": "semistandard", 17 | "test": "mocha" 18 | }, 19 | "dependencies": { 20 | "@google-cloud/datastore": "^5.0.0", 21 | "@google-cloud/debug-agent": "^4.0.0", 22 | "@google-cloud/vision": "^1.0.0", 23 | "cheerio": "^1.0.0-rc.2", 24 | "googleapis": "^63.0.0", 25 | "nconf": "^0.11.0", 26 | "pify": "^4.0.0" 27 | }, 28 | "devDependencies": { 29 | "mocha": "^8.0.0", 30 | "semistandard": "^14.0.1" 31 | }, 32 | "semistandard": { 33 | "env": [ "mocha" ] 34 | } 35 | } 36 | -------------------------------------------------------------------------------- /renovate.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": [ 3 | "config:base", 4 | "docker:disable" 5 | ], 6 | "pinVersions": false, 7 | "rebaseStalePrs": true 8 | } 9 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | /** 2 | * Copyright 2019, Google LLC 3 | * Licensed under the Apache License, Version 2.0 (the "License"); 4 | * you may not use this file except in compliance with the License. 5 | * You may obtain a copy of the License at 6 | * 7 | * http://www.apache.org/licenses/LICENSE-2.0 8 | * 9 | * Unless required by applicable law or agreed to in writing, software 10 | * distributed under the License is distributed on an "AS IS" BASIS, 11 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | * See the License for the specific language governing permissions and 13 | * limitations under the License. 14 | */ 15 | 16 | 'use strict'; 17 | 18 | const assert = require('assert'); 19 | 20 | describe('cloud functions gmail', () => { 21 | it('should have tests', () => { 22 | assert.ok(true); 23 | }); 24 | }); 25 | --------------------------------------------------------------------------------