From be867533a79976559caa20ffae255967832d9436 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C4=B1dvan=20Akca?= Date: Sun, 21 Apr 2024 16:18:18 +0200 Subject: [PATCH 01/14] feat(gmail): add gmail integration --- .../backend/src/apps/gmail/assets/favicon.svg | 11 +++++ .../src/apps/gmail/auth/generate-auth-url.js | 23 +++++++++ packages/backend/src/apps/gmail/auth/index.js | 48 +++++++++++++++++++ .../src/apps/gmail/auth/is-still-verified.js | 8 ++++ .../src/apps/gmail/auth/refresh-token.js | 26 ++++++++++ .../src/apps/gmail/auth/verify-credentials.js | 42 ++++++++++++++++ .../src/apps/gmail/common/add-auth-header.js | 9 ++++ .../src/apps/gmail/common/auth-scope.js | 8 ++++ .../src/apps/gmail/common/get-current-user.js | 8 ++++ packages/backend/src/apps/gmail/index.js | 15 ++++++ packages/docs/pages/.vitepress/config.js | 6 +++ packages/docs/pages/apps/gmail/connection.md | 28 +++++++++++ packages/docs/pages/public/favicons/gmail.svg | 11 +++++ 13 files changed, 243 insertions(+) create mode 100644 packages/backend/src/apps/gmail/assets/favicon.svg create mode 100644 packages/backend/src/apps/gmail/auth/generate-auth-url.js create mode 100644 packages/backend/src/apps/gmail/auth/index.js create mode 100644 packages/backend/src/apps/gmail/auth/is-still-verified.js create mode 100644 packages/backend/src/apps/gmail/auth/refresh-token.js create mode 100644 packages/backend/src/apps/gmail/auth/verify-credentials.js create mode 100644 packages/backend/src/apps/gmail/common/add-auth-header.js create mode 100644 packages/backend/src/apps/gmail/common/auth-scope.js create mode 100644 packages/backend/src/apps/gmail/common/get-current-user.js create mode 100644 packages/backend/src/apps/gmail/index.js create mode 100644 packages/docs/pages/apps/gmail/connection.md create mode 100644 packages/docs/pages/public/favicons/gmail.svg diff --git a/packages/backend/src/apps/gmail/assets/favicon.svg b/packages/backend/src/apps/gmail/assets/favicon.svg new file mode 100644 index 00000000..fc19b565 --- /dev/null +++ b/packages/backend/src/apps/gmail/assets/favicon.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/packages/backend/src/apps/gmail/auth/generate-auth-url.js b/packages/backend/src/apps/gmail/auth/generate-auth-url.js new file mode 100644 index 00000000..c972ae16 --- /dev/null +++ b/packages/backend/src/apps/gmail/auth/generate-auth-url.js @@ -0,0 +1,23 @@ +import { URLSearchParams } from 'url'; +import authScope from '../common/auth-scope.js'; + +export default async function generateAuthUrl($) { + const oauthRedirectUrlField = $.app.auth.fields.find( + (field) => field.key == 'oAuthRedirectUrl' + ); + const redirectUri = oauthRedirectUrlField.value; + const searchParams = new URLSearchParams({ + client_id: $.auth.data.clientId, + redirect_uri: redirectUri, + prompt: 'select_account', + scope: authScope.join(' '), + response_type: 'code', + access_type: 'offline', + }); + + const url = `https://accounts.google.com/o/oauth2/v2/auth?${searchParams.toString()}`; + + await $.auth.set({ + url, + }); +} diff --git a/packages/backend/src/apps/gmail/auth/index.js b/packages/backend/src/apps/gmail/auth/index.js new file mode 100644 index 00000000..c6946870 --- /dev/null +++ b/packages/backend/src/apps/gmail/auth/index.js @@ -0,0 +1,48 @@ +import generateAuthUrl from './generate-auth-url.js'; +import verifyCredentials from './verify-credentials.js'; +import refreshToken from './refresh-token.js'; +import isStillVerified from './is-still-verified.js'; + +export default { + fields: [ + { + key: 'oAuthRedirectUrl', + label: 'OAuth Redirect URL', + type: 'string', + required: true, + readOnly: true, + value: '{WEB_APP_URL}/app/gmail/connections/add', + placeholder: null, + description: + 'When asked to input a redirect URL in Google Cloud, enter the URL above.', + clickToCopy: true, + }, + { + key: 'clientId', + label: 'Client ID', + type: 'string', + required: true, + readOnly: false, + value: null, + placeholder: null, + description: null, + clickToCopy: false, + }, + { + key: 'clientSecret', + label: 'Client Secret', + type: 'string', + required: true, + readOnly: false, + value: null, + placeholder: null, + description: null, + clickToCopy: false, + }, + ], + + generateAuthUrl, + verifyCredentials, + isStillVerified, + refreshToken, +}; diff --git a/packages/backend/src/apps/gmail/auth/is-still-verified.js b/packages/backend/src/apps/gmail/auth/is-still-verified.js new file mode 100644 index 00000000..68f4d7db --- /dev/null +++ b/packages/backend/src/apps/gmail/auth/is-still-verified.js @@ -0,0 +1,8 @@ +import getCurrentUser from '../common/get-current-user.js'; + +const isStillVerified = async ($) => { + const currentUser = await getCurrentUser($); + return !!currentUser.resourceName; +}; + +export default isStillVerified; diff --git a/packages/backend/src/apps/gmail/auth/refresh-token.js b/packages/backend/src/apps/gmail/auth/refresh-token.js new file mode 100644 index 00000000..7c5b7020 --- /dev/null +++ b/packages/backend/src/apps/gmail/auth/refresh-token.js @@ -0,0 +1,26 @@ +import { URLSearchParams } from 'node:url'; + +import authScope from '../common/auth-scope.js'; + +const refreshToken = async ($) => { + const params = new URLSearchParams({ + client_id: $.auth.data.clientId, + client_secret: $.auth.data.clientSecret, + grant_type: 'refresh_token', + refresh_token: $.auth.data.refreshToken, + }); + + const { data } = await $.http.post( + 'https://oauth2.googleapis.com/token', + params.toString() + ); + + await $.auth.set({ + accessToken: data.access_token, + expiresIn: data.expires_in, + scope: authScope.join(' '), + tokenType: data.token_type, + }); +}; + +export default refreshToken; diff --git a/packages/backend/src/apps/gmail/auth/verify-credentials.js b/packages/backend/src/apps/gmail/auth/verify-credentials.js new file mode 100644 index 00000000..a636b72c --- /dev/null +++ b/packages/backend/src/apps/gmail/auth/verify-credentials.js @@ -0,0 +1,42 @@ +import getCurrentUser from '../common/get-current-user.js'; + +const verifyCredentials = async ($) => { + const oauthRedirectUrlField = $.app.auth.fields.find( + (field) => field.key == 'oAuthRedirectUrl' + ); + const redirectUri = oauthRedirectUrlField.value; + const { data } = await $.http.post(`https://oauth2.googleapis.com/token`, { + client_id: $.auth.data.clientId, + client_secret: $.auth.data.clientSecret, + code: $.auth.data.code, + grant_type: 'authorization_code', + redirect_uri: redirectUri, + }); + + await $.auth.set({ + accessToken: data.access_token, + tokenType: data.token_type, + }); + + const currentUser = await getCurrentUser($); + + const { displayName } = currentUser.names.find( + (name) => name.metadata.primary + ); + const { value: email } = currentUser.emailAddresses.find( + (emailAddress) => emailAddress.metadata.primary + ); + + await $.auth.set({ + clientId: $.auth.data.clientId, + clientSecret: $.auth.data.clientSecret, + scope: $.auth.data.scope, + idToken: data.id_token, + expiresIn: data.expires_in, + refreshToken: data.refresh_token, + resourceName: currentUser.resourceName, + screenName: `${displayName} - ${email}`, + }); +}; + +export default verifyCredentials; diff --git a/packages/backend/src/apps/gmail/common/add-auth-header.js b/packages/backend/src/apps/gmail/common/add-auth-header.js new file mode 100644 index 00000000..02477aa4 --- /dev/null +++ b/packages/backend/src/apps/gmail/common/add-auth-header.js @@ -0,0 +1,9 @@ +const addAuthHeader = ($, requestConfig) => { + if ($.auth.data?.accessToken) { + requestConfig.headers.Authorization = `${$.auth.data.tokenType} ${$.auth.data.accessToken}`; + } + + return requestConfig; +}; + +export default addAuthHeader; diff --git a/packages/backend/src/apps/gmail/common/auth-scope.js b/packages/backend/src/apps/gmail/common/auth-scope.js new file mode 100644 index 00000000..7f2b926f --- /dev/null +++ b/packages/backend/src/apps/gmail/common/auth-scope.js @@ -0,0 +1,8 @@ +const authScope = [ + 'https://www.googleapis.com/auth/gmail.compose', + 'https://www.googleapis.com/auth/gmail.modify', + 'https://www.googleapis.com/auth/userinfo.email', + 'https://www.googleapis.com/auth/userinfo.profile', +]; + +export default authScope; diff --git a/packages/backend/src/apps/gmail/common/get-current-user.js b/packages/backend/src/apps/gmail/common/get-current-user.js new file mode 100644 index 00000000..2663ad20 --- /dev/null +++ b/packages/backend/src/apps/gmail/common/get-current-user.js @@ -0,0 +1,8 @@ +const getCurrentUser = async ($) => { + const { data: currentUser } = await $.http.get( + 'https://people.googleapis.com/v1/people/me?personFields=names,emailAddresses' + ); + return currentUser; +}; + +export default getCurrentUser; diff --git a/packages/backend/src/apps/gmail/index.js b/packages/backend/src/apps/gmail/index.js new file mode 100644 index 00000000..0b9bfa0f --- /dev/null +++ b/packages/backend/src/apps/gmail/index.js @@ -0,0 +1,15 @@ +import defineApp from '../../helpers/define-app.js'; +import addAuthHeader from './common/add-auth-header.js'; +import auth from './auth/index.js'; +export default defineApp({ + name: 'Gmail', + key: 'gmail', + baseUrl: 'https://mail.google.com', + apiBaseUrl: 'https://gmail.googleapis.com', + iconUrl: '{BASE_URL}/apps/gmail/assets/favicon.svg', + authDocUrl: 'https://automatisch.io/docs/apps/gmail/connection', + primaryColor: 'ea4335', + supportsConnections: true, + beforeRequest: [addAuthHeader], + auth, +}); diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index dde76d78..a4ba2ef8 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -214,6 +214,12 @@ export default defineConfig({ { text: 'Connection', link: '/apps/gitlab/connection' }, ], }, + { + text: 'Gmail', + collapsible: true, + collapsed: true, + items: [{ text: 'Connection', link: '/apps/gmail/connection' }], + }, { text: 'Google Calendar', collapsible: true, diff --git a/packages/docs/pages/apps/gmail/connection.md b/packages/docs/pages/apps/gmail/connection.md new file mode 100644 index 00000000..aa91954e --- /dev/null +++ b/packages/docs/pages/apps/gmail/connection.md @@ -0,0 +1,28 @@ +# Gmail + +:::info +This page explains the steps you need to follow to set up the Gmail +connection in Automatisch. If any of the steps are outdated, please let us know! +::: + +1. Go to the [Google Cloud Console](https://console.cloud.google.com) to create a project. +2. Click on the project drop-down menu at the top of the page, and click on the **New Project** button. +3. Enter a name for your project and click on the **Create** button. +4. Go to [API Library](https://console.cloud.google.com/apis/library) in Google Cloud console. +5. Search for **People API** in the search bar and click on it. +6. Click on the **Enable** button to enable the API. +7. Repeat steps 5 and 6 for the **Gmail API** +8. Go to [OAuth consent screen](https://console.cloud.google.com/apis/credentials/consent) in Google Cloud console. +9. Select **External** here for starting your app in testing mode at first. Click on the **Create** button. +10. Fill **App Name**, **User Support Email**, and **Developer Contact Information**. Click on the **Save and Continue** button. +11. Skip adding or removing scopes and click on the **Save and Continue** button. +12. Click on the **Add Users** button and add a test email because only test users can access the app while publishing status is set to "Testing". +13. Click on the **Save and Continue** button and now you have configured the consent screen. +14. Go to [Credentials](https://console.cloud.google.com/apis/credentials) in Google Cloud console. +15. Click on the **Create Credentials** button and select the **OAuth client ID** option. +16. Select the application type as **Web application** and fill the **Name** field. +17. Copy **OAuth Redirect URL** from Automatisch to **Authorized redirect URIs** field, and click on the **Create** button. +18. Copy the **Your Client ID** value from the following popup to the `Client ID` field on Automatisch. +19. Copy the **Your Client Secret** value from the following popup to the `Client Secret` field on Automatisch. +20. Click **Submit** button on Automatisch. +21. Congrats! Start using your new Gmail connection within the flows. diff --git a/packages/docs/pages/public/favicons/gmail.svg b/packages/docs/pages/public/favicons/gmail.svg new file mode 100644 index 00000000..fc19b565 --- /dev/null +++ b/packages/docs/pages/public/favicons/gmail.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + From 83fe9fd36e8ef217db60edeafa89f80862bf3d29 Mon Sep 17 00:00:00 2001 From: "Jakub P." Date: Fri, 7 Feb 2025 10:38:42 +0100 Subject: [PATCH 02/14] task: update gmail to use docs_url --- packages/backend/src/apps/gmail/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/backend/src/apps/gmail/index.js b/packages/backend/src/apps/gmail/index.js index 0b9bfa0f..786e2a1e 100644 --- a/packages/backend/src/apps/gmail/index.js +++ b/packages/backend/src/apps/gmail/index.js @@ -7,7 +7,7 @@ export default defineApp({ baseUrl: 'https://mail.google.com', apiBaseUrl: 'https://gmail.googleapis.com', iconUrl: '{BASE_URL}/apps/gmail/assets/favicon.svg', - authDocUrl: 'https://automatisch.io/docs/apps/gmail/connection', + authDocUrl: '{DOCS_URL}/apps/gmail/connection', primaryColor: 'ea4335', supportsConnections: true, beforeRequest: [addAuthHeader], From 10bc5fc3ff10d7f22b482e07b14a352af639867d Mon Sep 17 00:00:00 2001 From: "Jakub P." Date: Fri, 7 Feb 2025 10:45:50 +0100 Subject: [PATCH 03/14] fix: add gmail to backend snapshot test --- packages/backend/src/models/__snapshots__/app.test.js.snap | 1 + 1 file changed, 1 insertion(+) diff --git a/packages/backend/src/models/__snapshots__/app.test.js.snap b/packages/backend/src/models/__snapshots__/app.test.js.snap index 33000024..f14423b4 100644 --- a/packages/backend/src/models/__snapshots__/app.test.js.snap +++ b/packages/backend/src/models/__snapshots__/app.test.js.snap @@ -25,6 +25,7 @@ exports[`App model > list should have list of applications keys 1`] = ` "ghost", "github", "gitlab", + "gmail", "google-calendar", "google-drive", "google-forms", From 715ab09d19d78dc3850085d1e6cd431534dd02c1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C4=B1dvan=20Akca?= Date: Mon, 22 Apr 2024 14:46:19 +0200 Subject: [PATCH 04/14] feat(gmail): add new emails trigger --- .../src/apps/gmail/auth/verify-credentials.js | 1 + .../src/apps/gmail/dynamic-data/index.js | 3 + .../gmail/dynamic-data/list-labels/index.js | 22 ++++++ packages/backend/src/apps/gmail/index.js | 5 ++ .../backend/src/apps/gmail/triggers/index.js | 3 + .../apps/gmail/triggers/new-emails/index.js | 68 +++++++++++++++++++ packages/docs/pages/apps/gmail/triggers.md | 12 ++++ packages/docs/pages/guide/available-apps.md | 1 + 8 files changed, 115 insertions(+) create mode 100644 packages/backend/src/apps/gmail/dynamic-data/index.js create mode 100644 packages/backend/src/apps/gmail/dynamic-data/list-labels/index.js create mode 100644 packages/backend/src/apps/gmail/triggers/index.js create mode 100644 packages/backend/src/apps/gmail/triggers/new-emails/index.js create mode 100644 packages/docs/pages/apps/gmail/triggers.md diff --git a/packages/backend/src/apps/gmail/auth/verify-credentials.js b/packages/backend/src/apps/gmail/auth/verify-credentials.js index a636b72c..8c9b7afe 100644 --- a/packages/backend/src/apps/gmail/auth/verify-credentials.js +++ b/packages/backend/src/apps/gmail/auth/verify-credentials.js @@ -36,6 +36,7 @@ const verifyCredentials = async ($) => { refreshToken: data.refresh_token, resourceName: currentUser.resourceName, screenName: `${displayName} - ${email}`, + userId: email, }); }; diff --git a/packages/backend/src/apps/gmail/dynamic-data/index.js b/packages/backend/src/apps/gmail/dynamic-data/index.js new file mode 100644 index 00000000..a7a52e3a --- /dev/null +++ b/packages/backend/src/apps/gmail/dynamic-data/index.js @@ -0,0 +1,3 @@ +import listLabels from './list-labels/index.js'; + +export default [listLabels]; diff --git a/packages/backend/src/apps/gmail/dynamic-data/list-labels/index.js b/packages/backend/src/apps/gmail/dynamic-data/list-labels/index.js new file mode 100644 index 00000000..65decf94 --- /dev/null +++ b/packages/backend/src/apps/gmail/dynamic-data/list-labels/index.js @@ -0,0 +1,22 @@ +export default { + name: 'List labels', + key: 'listLabels', + + async run($) { + const labels = { + data: [], + }; + const userId = $.auth.data.userId; + + const { data } = await $.http.get(`/gmail/v1/users/${userId}/labels`); + + for (const label of data.labels) { + labels.data.push({ + value: label.id, + name: label.name, + }); + } + + return labels; + }, +}; diff --git a/packages/backend/src/apps/gmail/index.js b/packages/backend/src/apps/gmail/index.js index 786e2a1e..a201ec19 100644 --- a/packages/backend/src/apps/gmail/index.js +++ b/packages/backend/src/apps/gmail/index.js @@ -1,6 +1,9 @@ import defineApp from '../../helpers/define-app.js'; import addAuthHeader from './common/add-auth-header.js'; import auth from './auth/index.js'; +import triggers from './triggers/index.js'; +import dynamicData from './dynamic-data/index.js'; + export default defineApp({ name: 'Gmail', key: 'gmail', @@ -12,4 +15,6 @@ export default defineApp({ supportsConnections: true, beforeRequest: [addAuthHeader], auth, + triggers, + dynamicData, }); diff --git a/packages/backend/src/apps/gmail/triggers/index.js b/packages/backend/src/apps/gmail/triggers/index.js new file mode 100644 index 00000000..3ce85787 --- /dev/null +++ b/packages/backend/src/apps/gmail/triggers/index.js @@ -0,0 +1,3 @@ +import newEmails from './new-emails/index.js'; + +export default [newEmails]; diff --git a/packages/backend/src/apps/gmail/triggers/new-emails/index.js b/packages/backend/src/apps/gmail/triggers/new-emails/index.js new file mode 100644 index 00000000..14006b56 --- /dev/null +++ b/packages/backend/src/apps/gmail/triggers/new-emails/index.js @@ -0,0 +1,68 @@ +import defineTrigger from '../../../../helpers/define-trigger.js'; + +export default defineTrigger({ + name: 'New emails', + key: 'newEmails', + pollInterval: 15, + description: + 'Triggers when a new email is received in the specified mailbox.', + arguments: [ + { + label: 'Label', + key: 'labelId', + type: 'dropdown', + required: false, + description: + "If you don't choose a label, this Zap will trigger for all emails, including Drafts.", + variables: true, + source: { + type: 'query', + name: 'getDynamicData', + arguments: [ + { + name: 'key', + value: 'listLabels', + }, + ], + }, + }, + ], + + async run($) { + const userId = $.auth.data.userId; + const labelId = $.step.parameters.labelId; + + const params = { + maxResults: 500, + pageToken: undefined, + }; + + if (labelId) { + params.labelIds = labelId; + } + + do { + const { data } = await $.http.get(`/gmail/v1/users/${userId}/messages`, { + params, + }); + params.pageToken = data.nextPageToken; + + if (!data?.messages?.length) { + return; + } + + for (const message of data.messages) { + const { data: messageData } = await $.http.get( + `/gmail/v1/users/${userId}/messages/${message.id}` + ); + + $.pushTriggerItem({ + raw: messageData, + meta: { + internalId: messageData.id, + }, + }); + } + } while (params.pageToken); + }, +}); diff --git a/packages/docs/pages/apps/gmail/triggers.md b/packages/docs/pages/apps/gmail/triggers.md new file mode 100644 index 00000000..49205c51 --- /dev/null +++ b/packages/docs/pages/apps/gmail/triggers.md @@ -0,0 +1,12 @@ +--- +favicon: /favicons/gmail.svg +items: + - name: New emails + desc: Triggers when a new email is received in the specified mailbox. +--- + + + + diff --git a/packages/docs/pages/guide/available-apps.md b/packages/docs/pages/guide/available-apps.md index 7bb4d57e..bde689dd 100644 --- a/packages/docs/pages/guide/available-apps.md +++ b/packages/docs/pages/guide/available-apps.md @@ -22,6 +22,7 @@ The following integrations are currently supported by Automatisch. - [Ghost](/apps/ghost/triggers) - [GitHub](/apps/github/triggers) - [GitLab](/apps/gitlab/triggers) +- [Gmail](/apps/gmail/triggers) - [Google Calendar](/apps/google-calendar/triggers) - [Google Drive](/apps/google-drive/triggers) - [Google Forms](/apps/google-forms/triggers) From e316114402090c3261068435e41dfe552361f2c4 Mon Sep 17 00:00:00 2001 From: "Jakub P." Date: Fri, 7 Feb 2025 11:48:09 +0100 Subject: [PATCH 05/14] task: update Gmail label description --- packages/backend/src/apps/gmail/triggers/new-emails/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/backend/src/apps/gmail/triggers/new-emails/index.js b/packages/backend/src/apps/gmail/triggers/new-emails/index.js index 14006b56..1853b049 100644 --- a/packages/backend/src/apps/gmail/triggers/new-emails/index.js +++ b/packages/backend/src/apps/gmail/triggers/new-emails/index.js @@ -13,7 +13,7 @@ export default defineTrigger({ type: 'dropdown', required: false, description: - "If you don't choose a label, this Zap will trigger for all emails, including Drafts.", + "If you don't choose a label, this event will be triggered for all emails, including Drafts.", variables: true, source: { type: 'query', From 9d19d9c4e8548596d367f23ca34a750b68065521 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C4=B1dvan=20Akca?= Date: Tue, 23 Apr 2024 11:54:56 +0200 Subject: [PATCH 06/14] feat(gmail): add send email action --- .../backend/src/apps/gmail/actions/index.js | 3 + .../apps/gmail/actions/send-email/index.js | 234 ++++++++++++++++++ .../src/apps/gmail/dynamic-data/index.js | 4 +- .../gmail/dynamic-data/list-emails/index.js | 23 ++ .../dynamic-data/list-signatures/index.js | 24 ++ packages/backend/src/apps/gmail/index.js | 2 + packages/docs/pages/.vitepress/config.js | 6 +- packages/docs/pages/apps/gmail/actions.md | 12 + 8 files changed, 306 insertions(+), 2 deletions(-) create mode 100644 packages/backend/src/apps/gmail/actions/index.js create mode 100644 packages/backend/src/apps/gmail/actions/send-email/index.js create mode 100644 packages/backend/src/apps/gmail/dynamic-data/list-emails/index.js create mode 100644 packages/backend/src/apps/gmail/dynamic-data/list-signatures/index.js create mode 100644 packages/docs/pages/apps/gmail/actions.md diff --git a/packages/backend/src/apps/gmail/actions/index.js b/packages/backend/src/apps/gmail/actions/index.js new file mode 100644 index 00000000..e1d8a996 --- /dev/null +++ b/packages/backend/src/apps/gmail/actions/index.js @@ -0,0 +1,3 @@ +import sendEmail from './send-email/index.js'; + +export default [sendEmail]; diff --git a/packages/backend/src/apps/gmail/actions/send-email/index.js b/packages/backend/src/apps/gmail/actions/send-email/index.js new file mode 100644 index 00000000..e8101324 --- /dev/null +++ b/packages/backend/src/apps/gmail/actions/send-email/index.js @@ -0,0 +1,234 @@ +import defineAction from '../../../../helpers/define-action.js'; + +export default defineAction({ + name: 'Send email', + key: 'sendEmail', + description: 'Send a new email message.', + arguments: [ + { + label: 'TOs', + key: 'tos', + type: 'dynamic', + required: false, + description: '', + fields: [ + { + label: 'To', + key: 'to', + type: 'string', + required: false, + variables: true, + }, + ], + }, + { + label: 'CCs', + key: 'ccs', + type: 'dynamic', + required: false, + description: '', + fields: [ + { + label: 'CC', + key: 'cc', + type: 'string', + required: false, + variables: true, + }, + ], + }, + { + label: 'BCCs', + key: 'bccs', + type: 'dynamic', + required: false, + description: '', + fields: [ + { + label: 'BCC', + key: 'bcc', + type: 'string', + required: false, + variables: true, + }, + ], + }, + { + label: 'From', + key: 'from', + type: 'dropdown', + required: false, + description: + 'Select an email address or alias from your Gmail Account. Defaults to the primary email address.', + variables: true, + source: { + type: 'query', + name: 'getDynamicData', + arguments: [ + { + name: 'key', + value: 'listEmails', + }, + ], + }, + }, + { + label: 'From Name', + key: 'fromName', + type: 'string', + required: false, + description: '', + variables: true, + }, + { + label: 'Reply To', + key: 'replyTo', + type: 'string', + required: false, + description: 'Specify a single reply address other than your own.', + variables: true, + }, + { + label: 'Subject', + key: 'subject', + type: 'string', + required: true, + description: '', + variables: true, + }, + { + label: 'Body Type', + key: 'bodyType', + type: 'dropdown', + required: false, + description: '', + variables: true, + options: [ + { + label: 'plain', + value: 'plain', + }, + { + label: 'html', + value: 'html', + }, + ], + }, + { + label: 'Body', + key: 'emailBody', + type: 'string', + required: true, + description: '', + variables: true, + }, + { + label: 'Signature', + key: 'signature', + type: 'dropdown', + required: false, + description: '', + variables: true, + source: { + type: 'query', + name: 'getDynamicData', + arguments: [ + { + name: 'key', + value: 'listSignatures', + }, + ], + }, + }, + { + label: 'Label', + key: 'labelId', + type: 'dropdown', + required: false, + description: '', + variables: true, + source: { + type: 'query', + name: 'getDynamicData', + arguments: [ + { + name: 'key', + value: 'listLabels', + }, + ], + }, + }, + ], + + async run($) { + const { + tos, + ccs, + bccs, + from, + fromName, + replyTo, + subject, + bodyType, + emailBody, + signature, + labelId, + } = $.step.parameters; + const userId = $.auth.data.userId; + + const allTos = tos?.map((entry) => entry.to); + const allCcs = ccs?.map((entry) => entry.cc); + const allBccs = bccs?.map((entry) => entry.bcc); + const contentType = + bodyType === 'html' + ? 'text/html; charset="UTF-8"' + : 'text/plain; charset="UTF-8"'; + + const email = + 'From: ' + + fromName + + ' <' + + from + + '>' + + '\r\n' + + 'Reply-To: ' + + replyTo + + '\r\n' + + 'To: ' + + allTos.join(',') + + '\r\n' + + 'Cc: ' + + allCcs.join(',') + + '\r\n' + + 'Bcc: ' + + allBccs.join(',') + + '\r\n' + + 'Subject: ' + + subject + + '\r\n' + + 'Content-Type: ' + + contentType + + '\r\n' + + '\r\n' + + emailBody + + '\r\n' + + '\r\n' + + signature; + + const base64EncodedEmailBody = Buffer.from(email).toString('base64'); + + const body = { + labelIds: [labelId], + raw: base64EncodedEmailBody, + }; + + const { data } = await $.http.post( + `/gmail/v1/users/${userId}/messages/send`, + body + ); + + $.setActionItem({ + raw: data, + }); + }, +}); diff --git a/packages/backend/src/apps/gmail/dynamic-data/index.js b/packages/backend/src/apps/gmail/dynamic-data/index.js index a7a52e3a..46af300e 100644 --- a/packages/backend/src/apps/gmail/dynamic-data/index.js +++ b/packages/backend/src/apps/gmail/dynamic-data/index.js @@ -1,3 +1,5 @@ +import listEmails from './list-emails/index.js'; import listLabels from './list-labels/index.js'; +import listSignatures from './list-signatures/index.js'; -export default [listLabels]; +export default [listEmails, listLabels, listSignatures]; diff --git a/packages/backend/src/apps/gmail/dynamic-data/list-emails/index.js b/packages/backend/src/apps/gmail/dynamic-data/list-emails/index.js new file mode 100644 index 00000000..1820a1a1 --- /dev/null +++ b/packages/backend/src/apps/gmail/dynamic-data/list-emails/index.js @@ -0,0 +1,23 @@ +import getCurrentUser from '../../common/get-current-user.js'; + +export default { + name: 'List emails', + key: 'listEmails', + + async run($) { + const emails = { + data: [], + }; + + const currentUser = await getCurrentUser($); + + for (const emailAddress of currentUser.emailAddresses) { + emails.data.push({ + value: emailAddress.value, + name: emailAddress.value, + }); + } + + return emails; + }, +}; diff --git a/packages/backend/src/apps/gmail/dynamic-data/list-signatures/index.js b/packages/backend/src/apps/gmail/dynamic-data/list-signatures/index.js new file mode 100644 index 00000000..dab0b38a --- /dev/null +++ b/packages/backend/src/apps/gmail/dynamic-data/list-signatures/index.js @@ -0,0 +1,24 @@ +export default { + name: 'List signatures', + key: 'listSignatures', + + async run($) { + const signatures = { + data: [], + }; + const userId = $.auth.data.userId; + + const { data } = await $.http.get( + `/gmail/v1/users/${userId}/settings/sendAs` + ); + + for (const sendAs of data.sendAs) { + signatures.data.push({ + value: sendAs.signature, + name: sendAs.sendAsEmail, + }); + } + + return signatures; + }, +}; diff --git a/packages/backend/src/apps/gmail/index.js b/packages/backend/src/apps/gmail/index.js index a201ec19..ca20b94b 100644 --- a/packages/backend/src/apps/gmail/index.js +++ b/packages/backend/src/apps/gmail/index.js @@ -3,6 +3,7 @@ import addAuthHeader from './common/add-auth-header.js'; import auth from './auth/index.js'; import triggers from './triggers/index.js'; import dynamicData from './dynamic-data/index.js'; +import actions from './actions/index.js'; export default defineApp({ name: 'Gmail', @@ -17,4 +18,5 @@ export default defineApp({ auth, triggers, dynamicData, + actions, }); diff --git a/packages/docs/pages/.vitepress/config.js b/packages/docs/pages/.vitepress/config.js index a4ba2ef8..62b13e44 100644 --- a/packages/docs/pages/.vitepress/config.js +++ b/packages/docs/pages/.vitepress/config.js @@ -218,7 +218,11 @@ export default defineConfig({ text: 'Gmail', collapsible: true, collapsed: true, - items: [{ text: 'Connection', link: '/apps/gmail/connection' }], + items: [ + { text: 'Triggers', link: '/apps/gmail/triggers' }, + { text: 'Connection', link: '/apps/gmail/connection' }, + { text: 'Actions', link: '/apps/gmail/actions' }, + ], }, { text: 'Google Calendar', diff --git a/packages/docs/pages/apps/gmail/actions.md b/packages/docs/pages/apps/gmail/actions.md new file mode 100644 index 00000000..2f12fe51 --- /dev/null +++ b/packages/docs/pages/apps/gmail/actions.md @@ -0,0 +1,12 @@ +--- +favicon: /favicons/gmail.svg +items: + - name: Send email + desc: Send a new email message. +--- + + + + From 99c958b54e4fba4d97dc345d20f9981e0d023543 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C4=B1dvan=20Akca?= Date: Wed, 24 Apr 2024 11:38:08 +0200 Subject: [PATCH 07/14] feat(gmail): add reply to email action --- .../backend/src/apps/gmail/actions/index.js | 3 +- .../gmail/actions/reply-to-email/index.js | 228 ++++++++++++++++++ .../src/apps/gmail/dynamic-data/index.js | 3 +- .../gmail/dynamic-data/list-threads/index.js | 31 +++ packages/docs/pages/apps/gmail/actions.md | 2 + 5 files changed, 265 insertions(+), 2 deletions(-) create mode 100644 packages/backend/src/apps/gmail/actions/reply-to-email/index.js create mode 100644 packages/backend/src/apps/gmail/dynamic-data/list-threads/index.js diff --git a/packages/backend/src/apps/gmail/actions/index.js b/packages/backend/src/apps/gmail/actions/index.js index e1d8a996..2c7da906 100644 --- a/packages/backend/src/apps/gmail/actions/index.js +++ b/packages/backend/src/apps/gmail/actions/index.js @@ -1,3 +1,4 @@ +import replyToEmail from './reply-to-email/index.js'; import sendEmail from './send-email/index.js'; -export default [sendEmail]; +export default [replyToEmail, sendEmail]; diff --git a/packages/backend/src/apps/gmail/actions/reply-to-email/index.js b/packages/backend/src/apps/gmail/actions/reply-to-email/index.js new file mode 100644 index 00000000..5585e6b1 --- /dev/null +++ b/packages/backend/src/apps/gmail/actions/reply-to-email/index.js @@ -0,0 +1,228 @@ +import defineAction from '../../../../helpers/define-action.js'; + +export default defineAction({ + name: 'Reply to email', + key: 'replyToEmail', + description: 'Respond to an email.', + arguments: [ + { + label: 'Thread', + key: 'threadId', + type: 'dropdown', + required: false, + description: '', + variables: true, + source: { + type: 'query', + name: 'getDynamicData', + arguments: [ + { + name: 'key', + value: 'listThreads', + }, + ], + }, + }, + { + label: 'TOs', + key: 'tos', + type: 'dynamic', + required: false, + description: 'Who will receive this email?', + fields: [ + { + label: 'To', + key: 'to', + type: 'string', + required: false, + variables: true, + }, + ], + }, + { + label: 'CCs', + key: 'ccs', + type: 'dynamic', + required: false, + description: + 'Who else needs to be included in the CC field of this email?', + fields: [ + { + label: 'CC', + key: 'cc', + type: 'string', + required: false, + variables: true, + }, + ], + }, + { + label: 'BCCs', + key: 'bccs', + type: 'dynamic', + required: false, + description: + 'Who else needs to be included in the BCC field of this email?', + fields: [ + { + label: 'BCC', + key: 'bcc', + type: 'string', + required: false, + variables: true, + }, + ], + }, + { + label: 'From', + key: 'from', + type: 'dropdown', + required: false, + description: + 'Choose an email address or alias from your Gmail Account. This defaults to the primary email address.', + variables: true, + source: { + type: 'query', + name: 'getDynamicData', + arguments: [ + { + name: 'key', + value: 'listEmails', + }, + ], + }, + }, + { + label: 'From Name', + key: 'fromName', + type: 'string', + required: false, + description: '', + variables: true, + }, + { + label: 'Reply To', + key: 'replyTo', + type: 'string', + required: false, + description: 'Specify a single reply address other than your own.', + variables: true, + }, + { + label: 'Body Type', + key: 'bodyType', + type: 'dropdown', + required: false, + description: '', + variables: true, + options: [ + { + label: 'plain', + value: 'plain', + }, + { + label: 'html', + value: 'html', + }, + ], + }, + { + label: 'Body', + key: 'emailBody', + type: 'string', + required: true, + description: '', + variables: true, + }, + { + label: 'Label', + key: 'labelId', + type: 'dropdown', + required: false, + description: '', + variables: true, + source: { + type: 'query', + name: 'getDynamicData', + arguments: [ + { + name: 'key', + value: 'listLabels', + }, + ], + }, + }, + ], + + async run($) { + const { + tos, + ccs, + bccs, + from, + fromName, + replyTo, + threadId, + bodyType, + emailBody, + labelId, + } = $.step.parameters; + const userId = $.auth.data.userId; + + const allTos = tos?.map((entry) => entry.to); + const allCcs = ccs?.map((entry) => entry.cc); + const allBccs = bccs?.map((entry) => entry.bcc); + const contentType = + bodyType === 'html' + ? 'text/html; charset="UTF-8"' + : 'text/plain; charset="UTF-8"'; + + const email = + 'From: ' + + fromName + + ' <' + + from + + '>' + + '\r\n' + + 'In-Reply-To: ' + + threadId + + '\r\n' + + 'References: ' + + threadId + + '\r\n' + + 'Reply-To: ' + + replyTo + + '\r\n' + + 'To: ' + + allTos.join(',') + + '\r\n' + + 'Cc: ' + + allCcs.join(',') + + '\r\n' + + 'Bcc: ' + + allBccs.join(',') + + '\r\n' + + 'Content-Type: ' + + contentType + + '\r\n' + + '\r\n' + + emailBody; + + const base64EncodedEmailBody = Buffer.from(email).toString('base64'); + + const body = { + threadId: threadId, + labelIds: [labelId], + raw: base64EncodedEmailBody, + }; + + const { data } = await $.http.post( + `/gmail/v1/users/${userId}/messages/send`, + body + ); + + $.setActionItem({ + raw: data, + }); + }, +}); diff --git a/packages/backend/src/apps/gmail/dynamic-data/index.js b/packages/backend/src/apps/gmail/dynamic-data/index.js index 46af300e..a89b1b9b 100644 --- a/packages/backend/src/apps/gmail/dynamic-data/index.js +++ b/packages/backend/src/apps/gmail/dynamic-data/index.js @@ -1,5 +1,6 @@ import listEmails from './list-emails/index.js'; import listLabels from './list-labels/index.js'; import listSignatures from './list-signatures/index.js'; +import listThreads from './list-threads/index.js'; -export default [listEmails, listLabels, listSignatures]; +export default [listEmails, listLabels, listSignatures, listThreads]; diff --git a/packages/backend/src/apps/gmail/dynamic-data/list-threads/index.js b/packages/backend/src/apps/gmail/dynamic-data/list-threads/index.js new file mode 100644 index 00000000..6d40fa2f --- /dev/null +++ b/packages/backend/src/apps/gmail/dynamic-data/list-threads/index.js @@ -0,0 +1,31 @@ +export default { + name: 'List threads', + key: 'listThreads', + + async run($) { + const threads = { + data: [], + }; + const userId = $.auth.data.userId; + + const { data } = await $.http.get(`/gmail/v1/users/${userId}/threads`); + + if (data.threads) { + for (const thread of data.threads) { + const { data: threadData } = await $.http.get( + `/gmail/v1/users/${userId}/threads/${thread.id}` + ); + const subject = threadData.messages[0].payload.headers.find( + (header) => header.name === 'Subject' + ); + + threads.data.push({ + value: thread.id, + name: subject?.value, + }); + } + } + + return threads; + }, +}; diff --git a/packages/docs/pages/apps/gmail/actions.md b/packages/docs/pages/apps/gmail/actions.md index 2f12fe51..7b979195 100644 --- a/packages/docs/pages/apps/gmail/actions.md +++ b/packages/docs/pages/apps/gmail/actions.md @@ -1,6 +1,8 @@ --- favicon: /favicons/gmail.svg items: + - name: Reply to email + desc: Respond to an email. - name: Send email desc: Send a new email message. --- From 0f76470656770ff165b97b8a8e79256ea06cd661 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C4=B1dvan=20Akca?= Date: Wed, 24 Apr 2024 12:23:04 +0200 Subject: [PATCH 08/14] feat(gmail): add create draft action --- .../apps/gmail/actions/create-draft/index.js | 204 ++++++++++++++++++ .../backend/src/apps/gmail/actions/index.js | 3 +- packages/docs/pages/apps/gmail/actions.md | 2 + 3 files changed, 208 insertions(+), 1 deletion(-) create mode 100644 packages/backend/src/apps/gmail/actions/create-draft/index.js diff --git a/packages/backend/src/apps/gmail/actions/create-draft/index.js b/packages/backend/src/apps/gmail/actions/create-draft/index.js new file mode 100644 index 00000000..e42c772a --- /dev/null +++ b/packages/backend/src/apps/gmail/actions/create-draft/index.js @@ -0,0 +1,204 @@ +import defineAction from '../../../../helpers/define-action.js'; + +export default defineAction({ + name: 'Create draft', + key: 'createDraft', + description: 'Create a new draft email message.', + arguments: [ + { + label: 'Subject', + key: 'subject', + type: 'string', + required: true, + description: '', + variables: true, + }, + { + label: 'TOs', + key: 'tos', + type: 'dynamic', + required: false, + description: '', + fields: [ + { + label: 'To', + key: 'to', + type: 'string', + required: false, + variables: true, + }, + ], + }, + { + label: 'CCs', + key: 'ccs', + type: 'dynamic', + required: false, + description: '', + fields: [ + { + label: 'CC', + key: 'cc', + type: 'string', + required: false, + variables: true, + }, + ], + }, + { + label: 'BCCs', + key: 'bccs', + type: 'dynamic', + required: false, + description: '', + fields: [ + { + label: 'BCC', + key: 'bcc', + type: 'string', + required: false, + variables: true, + }, + ], + }, + { + label: 'From', + key: 'from', + type: 'dropdown', + required: false, + description: + 'Select an email address or alias from your Gmail Account. Defaults to the primary email address.', + variables: true, + source: { + type: 'query', + name: 'getDynamicData', + arguments: [ + { + name: 'key', + value: 'listEmails', + }, + ], + }, + }, + { + label: 'From Name', + key: 'fromName', + type: 'string', + required: false, + description: '', + variables: true, + }, + { + label: 'Body Type', + key: 'bodyType', + type: 'dropdown', + required: false, + description: '', + variables: true, + options: [ + { + label: 'plain', + value: 'plain', + }, + { + label: 'html', + value: 'html', + }, + ], + }, + { + label: 'Body', + key: 'emailBody', + type: 'string', + required: true, + description: '', + variables: true, + }, + { + label: 'Signature', + key: 'signature', + type: 'dropdown', + required: false, + description: '', + variables: true, + source: { + type: 'query', + name: 'getDynamicData', + arguments: [ + { + name: 'key', + value: 'listSignatures', + }, + ], + }, + }, + ], + + async run($) { + const { + tos, + ccs, + bccs, + from, + fromName, + subject, + bodyType, + emailBody, + signature, + } = $.step.parameters; + const userId = $.auth.data.userId; + + const allTos = tos?.map((entry) => entry.to); + const allCcs = ccs?.map((entry) => entry.cc); + const allBccs = bccs?.map((entry) => entry.bcc); + const contentType = + bodyType === 'html' + ? 'text/html; charset="UTF-8"' + : 'text/plain; charset="UTF-8"'; + + const email = + 'From: ' + + fromName + + ' <' + + from + + '>' + + '\r\n' + + 'To: ' + + allTos.join(',') + + '\r\n' + + 'Cc: ' + + allCcs.join(',') + + '\r\n' + + 'Bcc: ' + + allBccs.join(',') + + '\r\n' + + 'Subject: ' + + subject + + '\r\n' + + 'Content-Type: ' + + contentType + + '\r\n' + + '\r\n' + + emailBody + + '\r\n' + + '\r\n' + + signature; + + const base64EncodedEmailBody = Buffer.from(email).toString('base64'); + + const body = { + message: { + raw: base64EncodedEmailBody, + }, + }; + + const { data } = await $.http.post( + `/gmail/v1/users/${userId}/drafts`, + body + ); + + $.setActionItem({ + raw: data, + }); + }, +}); diff --git a/packages/backend/src/apps/gmail/actions/index.js b/packages/backend/src/apps/gmail/actions/index.js index 2c7da906..7caffcf9 100644 --- a/packages/backend/src/apps/gmail/actions/index.js +++ b/packages/backend/src/apps/gmail/actions/index.js @@ -1,4 +1,5 @@ +import createDraft from './create-draft/index.js'; import replyToEmail from './reply-to-email/index.js'; import sendEmail from './send-email/index.js'; -export default [replyToEmail, sendEmail]; +export default [createDraft, replyToEmail, sendEmail]; diff --git a/packages/docs/pages/apps/gmail/actions.md b/packages/docs/pages/apps/gmail/actions.md index 7b979195..af323a5a 100644 --- a/packages/docs/pages/apps/gmail/actions.md +++ b/packages/docs/pages/apps/gmail/actions.md @@ -1,6 +1,8 @@ --- favicon: /favicons/gmail.svg items: + - name: Create draft + desc: Create a new draft email message. - name: Reply to email desc: Respond to an email. - name: Send email From 81c9ea8d971b11d6e4c795f08198e9cdcf875a86 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C4=B1dvan=20Akca?= Date: Wed, 24 Apr 2024 13:24:13 +0200 Subject: [PATCH 09/14] feat(gmail): add send to trash action --- .../backend/src/apps/gmail/actions/index.js | 3 +- .../apps/gmail/actions/send-to-trash/index.js | 30 +++++++++++++++++++ packages/docs/pages/apps/gmail/actions.md | 2 ++ 3 files changed, 34 insertions(+), 1 deletion(-) create mode 100644 packages/backend/src/apps/gmail/actions/send-to-trash/index.js diff --git a/packages/backend/src/apps/gmail/actions/index.js b/packages/backend/src/apps/gmail/actions/index.js index 7caffcf9..9a3816a9 100644 --- a/packages/backend/src/apps/gmail/actions/index.js +++ b/packages/backend/src/apps/gmail/actions/index.js @@ -1,5 +1,6 @@ import createDraft from './create-draft/index.js'; import replyToEmail from './reply-to-email/index.js'; import sendEmail from './send-email/index.js'; +import sendToTrash from './send-to-trash/index.js'; -export default [createDraft, replyToEmail, sendEmail]; +export default [createDraft, replyToEmail, sendEmail, sendToTrash]; diff --git a/packages/backend/src/apps/gmail/actions/send-to-trash/index.js b/packages/backend/src/apps/gmail/actions/send-to-trash/index.js new file mode 100644 index 00000000..8403025c --- /dev/null +++ b/packages/backend/src/apps/gmail/actions/send-to-trash/index.js @@ -0,0 +1,30 @@ +import defineAction from '../../../../helpers/define-action.js'; + +export default defineAction({ + name: 'Send to trash', + key: 'sendToTrash', + description: 'Send an existing email message to the trash.', + arguments: [ + { + label: 'Message ID', + key: 'messageId', + type: 'string', + required: true, + description: '', + variables: true, + }, + ], + + async run($) { + const { messageId } = $.step.parameters; + const userId = $.auth.data.userId; + + const { data } = await $.http.post( + `/gmail/v1/users/${userId}/messages/${messageId}/trash` + ); + + $.setActionItem({ + raw: data, + }); + }, +}); diff --git a/packages/docs/pages/apps/gmail/actions.md b/packages/docs/pages/apps/gmail/actions.md index af323a5a..2ad3178c 100644 --- a/packages/docs/pages/apps/gmail/actions.md +++ b/packages/docs/pages/apps/gmail/actions.md @@ -7,6 +7,8 @@ items: desc: Respond to an email. - name: Send email desc: Send a new email message. + - name: Send to trash + desc: Send an existing email message to the trash. ---