[ACTION] Gmail Find Email actions return too much text #16824 (#16830)

luancazarine · dannyroosevelt · web-flow · commit 72ffb850e0f4 · 2025-05-28T20:36:06.000-07:00
* adds payload validation

* some adjusts

* pnpm update

* Apply suggestions from code review

---------

Co-authored-by: Danny Roosevelt &lt;danny@pipedream.com&gt;
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.8",
+  version: "0.0.9",
   type: "action",
   props: {
     gmail,
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.4",
+  version: "0.0.5",
   type: "action",
   props: {
     gmail,
diff --git a/components/gmail/actions/archive-email/archive-email.mjs b/components/gmail/actions/archive-email/archive-email.mjs
@@ -1,11 +1,11 @@
-import gmail from "../../gmail.app.mjs";
 import constants from "../../common/constants.mjs";
+import gmail from "../../gmail.app.mjs";
 
 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.2",
+  version: "0.0.3",
   type: "action",
   props: {
     gmail,
diff --git a/components/gmail/actions/create-draft/create-draft.mjs b/components/gmail/actions/create-draft/create-draft.mjs
@@ -1,12 +1,12 @@
-import gmail from "../../gmail.app.mjs";
 import { ConfigurationError } from "@pipedream/platform";
 import utils from "../../common/utils.mjs";
+import gmail from "../../gmail.app.mjs";
 
 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.1",
+  version: "0.1.2",
   type: "action",
   props: {
     gmail,
diff --git a/components/gmail/actions/download-attachment/download-attachment.mjs b/components/gmail/actions/download-attachment/download-attachment.mjs
@@ -1,13 +1,13 @@
-import gmail from "../../gmail.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
 import fs from "fs";
 import path from "path";
-import { ConfigurationError } from "@pipedream/platform";
+import gmail from "../../gmail.app.mjs";
 
 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.6",
+  version: "0.0.7",
   type: "action",
   props: {
     gmail,
diff --git a/components/gmail/actions/find-email/find-email.mjs b/components/gmail/actions/find-email/find-email.mjs
@@ -1,10 +1,11 @@
+import { convert } from "html-to-text";
 import gmail from "../../gmail.app.mjs";
 
 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.0.11",
+  version: "0.1.0",
   type: "action",
   props: {
     gmail,
@@ -14,6 +15,12 @@ export default {
         "q",
       ],
     },
+    withTextPayload: {
+      type: "boolean",
+      label: "Return payload as plaintext",
+      description: "Convert the payload response into a single text field. **This reduces the size of the payload and makes it easier for LLMs work with.**",
+      default: false,
+    },
     labels: {
       propDefinition: [
         gmail,
@@ -47,14 +54,21 @@ export default {
       maxResults: this.maxResults,
     });
     const messageIds = messages.map(({ id }) => id);
-    const messagesToEmit = await this.gmail.getMessages(messageIds);
+    let messagesToEmit = await this.gmail.getMessages(messageIds);
 
     for await (const message of messagesToEmit) {
+      let newPayload = "";
       for (const part of message.payload?.parts || []) {
         if (part.body.data) {
-          part.body.text = Buffer.from(part.body.data, "base64").toString("utf-8");
+          const payload = Buffer.from(part.body.data, "base64").toString("utf-8");
+          this.withTextPayload
+            ? newPayload += convert(payload)
+            : part.body.text = payload;
         }
       }
+      if (this.withTextPayload) {
+        message.payload = newPayload;
+      }
     }
 
     const suffix = messagesToEmit.length === 1
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.3",
+  version: "0.0.4",
   type: "action",
   props: {
     gmail,
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.5",
+  version: "0.0.6",
   type: "action",
   props: {
     gmail,
diff --git a/components/gmail/actions/send-email/send-email.mjs b/components/gmail/actions/send-email/send-email.mjs
@@ -1,12 +1,12 @@
-import gmail from "../../gmail.app.mjs";
 import { ConfigurationError } from "@pipedream/platform";
 import utils from "../../common/utils.mjs";
+import gmail from "../../gmail.app.mjs";
 
 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.1.9",
+  version: "0.1.10",
   type: "action",
   props: {
     gmail,
diff --git a/components/gmail/actions/update-org-signature/update-org-signature.mjs b/components/gmail/actions/update-org-signature/update-org-signature.mjs
@@ -1,14 +1,14 @@
 import googleCloud from "../../../google_cloud/google_cloud.app.mjs";
-import base from "../update-primary-signature/update-primary-signature.mjs";
 import gmail from "../../gmail.app.mjs";
+import base from "../update-primary-signature/update-primary-signature.mjs";
 
 export default {
   ...base,
   key: "gmail-update-org-signature",
   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.6",
+  version: "0.0.7",
   type: "action",
   props: {
     gmail,
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.6",
+  version: "0.0.7",
   type: "action",
   props: {
     gmail,
diff --git a/components/gmail/package.json b/components/gmail/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/gmail",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Pipedream Gmail Components",
   "main": "gmail.app.mjs",
   "keywords": [
@@ -19,7 +19,7 @@
     "@pipedream/platform": "^3.0.3",
     "google-auth-library": "^8.7.0",
     "googleapis": "^105.0.0",
-    "html-to-text": "^8.2.1",
+    "html-to-text": "^9.0.5",
     "mime": "^3.0.0",
     "nodemailer": "^6.7.8",
     "uuid": "^10.0.0"
diff --git a/components/gmail/sources/new-attachment-received/new-attachment-received.mjs b/components/gmail/sources/new-attachment-received/new-attachment-received.mjs
@@ -6,7 +6,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.0.11",
+  version: "0.0.12",
   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.0.9",
+  version: "0.0.10",
   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
@@ -1,12 +1,12 @@
-import gmail from "../../gmail.app.mjs";
-import common from "../common/polling-history.mjs";
+import { PubSub } from "@google-cloud/pubsub";
 import {
   axios,
-  DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
   ConfigurationError,
+  DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
 } from "@pipedream/platform";
-import { PubSub } from "@google-cloud/pubsub";
 import { v4 as uuidv4 } from "uuid";
+import gmail from "../../gmail.app.mjs";
+import common from "../common/polling-history.mjs";
 import verifyClient from "../common/verify-client-id.mjs";
 
 export default {
@@ -15,7 +15,7 @@ export default {
   name: "New Email Received",
   description: "Emit new event when a new email is received.",
   type: "source",
-  version: "0.2.4",
+  version: "0.2.5",
   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.0.11",
+  version: "0.0.12",
   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.0.10",
+  version: "0.0.11",
   type: "source",
   dedupe: "unique",
   props: {
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
