Enhance Gmail component with thread message listing functionality (#18984)

luancazarine · web-flow · commit 2302b6697876 · 2025-11-10T16:28:49.000-03:00
* Enhance Gmail component with thread message listing functionality

- Added a new action to list messages within a specific thread.
- Introduced `listThreads` and `getThread` methods to facilitate thread message retrieval.
- Updated version to 1.4.0 to reflect the new features.

* Update version numbers for multiple Gmail actions and sources

- Bumped version numbers for various actions, including:
  - Add Label to Email (0.0.14 to 0.0.15)
  - Approve Workflow (0.0.11 to 0.0.12)
  - Archive Email (0.0.9 to 0.0.10)
  - Create Draft (0.1.9 to 0.1.10)
  - Create Label (0.0.3 to 0.0.4)
  - Delete Email (0.0.3 to 0.0.4)
  - Download Attachment (0.0.14 to 0.0.15)
  - Find Email (0.1.8 to 0.1.9)
  - Get Send As Alias (0.0.3 to 0.0.4)
  - List Labels (0.0.10 to 0.0.11)
  - List Send As Aliases (0.0.3 to 0.0.4)
  - Remove Label from Email (0.0.12 to 0.0.13)
  - Send Email (0.2.1 to 0.2.2)
  - Update Org Signature (0.0.13 to 0.0.14)
  - Update Primary Signature (0.0.13 to 0.0.14)
  - New Attachment Received (0.2.2 to 0.2.3)
  - New Email Matching Search (0.1.2 to 0.1.3)
  - New Email Received (0.3.2 to 0.3.3)
  - New Labeled Email (0.1.2 to 0.1.3)
  - New Sent Email (0.1.2 to 0.1.3)
diff --git a/components/gmail/actions/add-label-to-email/add-label-to-email.mjs b/components/gmail/actions/add-label-to-email/add-label-to-email.mjs
@@ -4,7 +4,7 @@ export default {
   key: "gmail-add-label-to-email",
   name: "Add Label to Email",
   description: "Add label(s) to an email message. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify)",
-  version: "0.0.14",
+  version: "0.0.15",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,
diff --git a/components/gmail/actions/approve-workflow/approve-workflow.mjs b/components/gmail/actions/approve-workflow/approve-workflow.mjs
@@ -4,7 +4,7 @@ export default {
   key: "gmail-approve-workflow",
   name: "Approve Workflow",
   description: "Suspend the workflow until approved by email. [See the documentation](https://pipedream.com/docs/code/nodejs/rerun#flowsuspend)",
-  version: "0.0.11",
+  version: "0.0.12",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
diff --git a/components/gmail/actions/archive-email/archive-email.mjs b/components/gmail/actions/archive-email/archive-email.mjs
@@ -5,7 +5,7 @@ export default {
   key: "gmail-archive-email",
   name: "Archive Email",
   description: "Archive an email message. [See the documentation](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify)",
-  version: "0.0.9",
+  version: "0.0.10",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,
diff --git a/components/gmail/actions/create-draft/create-draft.mjs b/components/gmail/actions/create-draft/create-draft.mjs
@@ -6,7 +6,7 @@ export default {
   key: "gmail-create-draft",
   name: "Create Draft",
   description: "Create a draft from your Google Workspace email account. [See the documentation](https://developers.google.com/gmail/api/reference/rest/v1/users.drafts/create)",
-  version: "0.1.9",
+  version: "0.1.10",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
diff --git a/components/gmail/actions/create-label/create-label.mjs b/components/gmail/actions/create-label/create-label.mjs
@@ -6,7 +6,7 @@ export default {
   key: "gmail-create-label",
   name: "Create Label",
   description: "Create a new label in the connected account. [See the documentation](https://developers.google.com/workspace/gmail/api/reference/rest/v1/users.labels/create)",
-  version: "0.0.3",
+  version: "0.0.4",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
diff --git a/components/gmail/actions/delete-email/delete-email.mjs b/components/gmail/actions/delete-email/delete-email.mjs
@@ -5,7 +5,7 @@ export default {
   key: "gmail-delete-email",
   name: "Delete Email",
   description: "Moves the specified message to the trash. [See the documentation](https://developers.google.com/workspace/gmail/api/reference/rest/v1/users.messages/trash)",
-  version: "0.0.3",
+  version: "0.0.4",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,
diff --git a/components/gmail/actions/download-attachment/download-attachment.mjs b/components/gmail/actions/download-attachment/download-attachment.mjs
@@ -7,7 +7,7 @@ export default {
   key: "gmail-download-attachment",
   name: "Download Attachment",
   description: "Download an attachment by attachmentId to the /tmp directory. [See the documentation](https://developers.google.com/gmail/api/reference/rest/v1/users.messages.attachments/get)",
-  version: "0.0.14",
+  version: "0.0.15",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
diff --git a/components/gmail/actions/find-email/find-email.mjs b/components/gmail/actions/find-email/find-email.mjs
@@ -5,7 +5,7 @@ export default {
   key: "gmail-find-email",
   name: "Find Email",
   description: "Find an email using Google's Search Engine. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/list)",
-  version: "0.1.8",
+  version: "0.1.9",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
diff --git a/components/gmail/actions/get-send-as-alias/get-send-as-alias.mjs b/components/gmail/actions/get-send-as-alias/get-send-as-alias.mjs
@@ -5,7 +5,7 @@ export default {
   key: "gmail-get-send-as-alias",
   name: "Get Send As Alias",
   description: "Get a send as alias for the authenticated user. [See the documentation](https://developers.google.com/workspace/gmail/api/reference/rest/v1/users.settings.sendAs/get)",
-  version: "0.0.3",
+  version: "0.0.4",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
diff --git a/components/gmail/actions/list-labels/list-labels.mjs b/components/gmail/actions/list-labels/list-labels.mjs
@@ -4,7 +4,7 @@ export default {
   key: "gmail-list-labels",
   name: "List Labels",
   description: "List all the existing labels in the connected account. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.labels/list)",
-  version: "0.0.10",
+  version: "0.0.11",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
diff --git a/components/gmail/actions/list-send-as-aliases/list-send-as-aliases.mjs b/components/gmail/actions/list-send-as-aliases/list-send-as-aliases.mjs
@@ -4,7 +4,7 @@ export default {
   key: "gmail-list-send-as-aliases",
   name: "List Send As Aliases",
   description: "List all send as aliases for the authenticated user. [See the documentation](https://developers.google.com/workspace/gmail/api/reference/rest/v1/users.settings.sendAs/list)",
-  version: "0.0.3",
+  version: "0.0.4",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
diff --git a/components/gmail/actions/list-thread-messages/list-thread-messages.mjs b/components/gmail/actions/list-thread-messages/list-thread-messages.mjs
@@ -0,0 +1,34 @@
+import gmail from "../../gmail.app.mjs";
+
+export default {
+  key: "gmail-list-thread-messages",
+  name: "List Thread Messages",
+  description: "List messages in a thread. [See the docs](https://developers.google.com/workspace/gmail/api/reference/rest/v1/users.threads/get)",
+  version: "0.0.1",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    gmail,
+    threadId: {
+      propDefinition: [
+        gmail,
+        "threadId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const { messages = [] } = await this.gmail.getThread({
+      threadId: this.threadId,
+    });
+
+    const suffix = messages.length === 1
+      ? ""
+      : "s";
+    $.export("$summary", `Successfully listed ${messages.length} message${suffix}`);
+    return messages;
+  },
+};
diff --git a/components/gmail/actions/remove-label-from-email/remove-label-from-email.mjs b/components/gmail/actions/remove-label-from-email/remove-label-from-email.mjs
@@ -4,7 +4,7 @@ export default {
   key: "gmail-remove-label-from-email",
   name: "Remove Label from Email",
   description: "Remove label(s) from an email message. [See the docs](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/modify)",
-  version: "0.0.12",
+  version: "0.0.13",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,
diff --git a/components/gmail/actions/send-email/send-email.mjs b/components/gmail/actions/send-email/send-email.mjs
@@ -6,7 +6,7 @@ export default {
   key: "gmail-send-email",
   name: "Send Email",
   description: "Send an email from your Google Workspace email account. [See the documentation](https://developers.google.com/gmail/api/reference/rest/v1/users.messages/send)",
-  version: "0.2.1",
+  version: "0.2.2",
   annotations: {
     destructiveHint: false,
     openWorldHint: true,
diff --git a/components/gmail/actions/update-org-signature/update-org-signature.mjs b/components/gmail/actions/update-org-signature/update-org-signature.mjs
@@ -8,7 +8,7 @@ export default {
   name: "Update Signature for Email in Organization",
   description: `Update the signature for a specific email address in an organization.
     A Google Cloud service account with delegated domain-wide authority is required for this action. [See the documentation](https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/update)`,
-  version: "0.0.13",
+  version: "0.0.14",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,
diff --git a/components/gmail/actions/update-primary-signature/update-primary-signature.mjs b/components/gmail/actions/update-primary-signature/update-primary-signature.mjs
@@ -4,7 +4,7 @@ export default {
   key: "gmail-update-primary-signature",
   name: "Update Signature for Primary Email Address",
   description: "Update the signature for the primary email address. [See the documentation](https://developers.google.com/gmail/api/reference/rest/v1/users.settings.sendAs/update)",
-  version: "0.0.13",
+  version: "0.0.14",
   annotations: {
     destructiveHint: true,
     openWorldHint: true,
diff --git a/components/gmail/gmail.app.mjs b/components/gmail/gmail.app.mjs
@@ -3,12 +3,12 @@ import {
   axios,
   ConfigurationError,
 } from "@pipedream/platform";
+import { JWT } from "google-auth-library";
 import { convert } from "html-to-text";
 import mime from "mime/types/standard.js";
-import MailComposer from "nodemailer/lib/mail-composer/index.js";
 import addressparser from "nodemailer/lib/addressparser/index.js";
+import MailComposer from "nodemailer/lib/mail-composer/index.js";
 import constants from "./common/constants.mjs";
-import { JWT } from "google-auth-library";
 
 export default {
   type: "app",
@@ -166,6 +166,33 @@ export default {
         }
       },
     },
+    threadId: {
+      type: "string",
+      label: "Thread ID",
+      description: "Identifier of the thread to list messages from",
+      async options({ prevContext }) {
+        try {
+          const {
+            threads, nextPageToken,
+          } = await this.listThreads({
+            pageToken: prevContext?.nextPageToken,
+          });
+          return {
+            options: threads.map(({
+              id: value, snippet: label,
+            }) => ({
+              value,
+              label,
+            })),
+            context: {
+              nextPageToken,
+            },
+          };
+        } catch {
+          return [];
+        }
+      },
+    },
     q: {
       type: "string",
       label: "Search Query",
@@ -421,6 +448,20 @@ export default {
       });
       return data;
     },
+    async listThreads(opts = {}) {
+      const { data } = await this._client().users.threads.list({
+        userId: constants.USER_ID,
+        ...opts,
+      });
+      return data;
+    },
+    async getThread({ threadId }) {
+      const { data } = await this._client().users.threads.get({
+        userId: constants.USER_ID,
+        id: threadId,
+      });
+      return data;
+    },
     async getProfile() {
       const { data } = await this._client().users.getProfile({
         userId: constants.USER_ID,
diff --git a/components/gmail/package.json b/components/gmail/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/gmail",
-  "version": "1.3.5",
+  "version": "1.4.0",
   "description": "Pipedream Gmail Components",
   "main": "gmail.app.mjs",
   "keywords": [
diff --git a/components/gmail/sources/new-attachment-received/new-attachment-received.mjs b/components/gmail/sources/new-attachment-received/new-attachment-received.mjs
@@ -8,7 +8,7 @@ export default {
   key: "gmail-new-attachment-received",
   name: "New Attachment Received",
   description: "Emit new event for each attachment in a message received. This source is capped at 100 max new messages per run.",
-  version: "0.2.2",
+  version: "0.2.3",
   type: "source",
   dedupe: "unique",
   props: {
diff --git a/components/gmail/sources/new-email-matching-search/new-email-matching-search.mjs b/components/gmail/sources/new-email-matching-search/new-email-matching-search.mjs
@@ -6,7 +6,7 @@ export default {
   key: "gmail-new-email-matching-search",
   name: "New Email Matching Search",
   description: "Emit new event when an email matching the search criteria is received. This source is capped at 100 max new messages per run.",
-  version: "0.1.2",
+  version: "0.1.3",
   type: "source",
   dedupe: "unique",
   props: {
diff --git a/components/gmail/sources/new-email-received/new-email-received.mjs b/components/gmail/sources/new-email-received/new-email-received.mjs
@@ -15,7 +15,7 @@ export default {
   name: "New Email Received",
   description: "Emit new event when a new email is received.",
   type: "source",
-  version: "0.3.2",
+  version: "0.3.3",
   dedupe: "unique",
   props: {
     gmail,
diff --git a/components/gmail/sources/new-labeled-email/new-labeled-email.mjs b/components/gmail/sources/new-labeled-email/new-labeled-email.mjs
@@ -8,7 +8,7 @@ export default {
   name: "New Labeled Email",
   description: "Emit new event when a new email is labeled.",
   type: "source",
-  version: "0.1.2",
+  version: "0.1.3",
   dedupe: "unique",
   props: {
     gmail,
diff --git a/components/gmail/sources/new-sent-email/new-sent-email.mjs b/components/gmail/sources/new-sent-email/new-sent-email.mjs
@@ -6,7 +6,7 @@ export default {
   key: "gmail-new-sent-email",
   name: "New Sent Email",
   description: "Emit new event for each new email sent. (Maximum of 100 events emited per execution)",
-  version: "0.1.2",
+  version: "0.1.3",
   type: "source",
   dedupe: "unique",
   props: {
