Download Attachment with Gmail (Developer App) API on New Attachment Received from Gmail API

Pipedream makes it easy to connect APIs for Gmail (Developer App), Gmail and 2,400+ other apps remarkably fast.

Trigger workflow on

New Attachment Received from the Gmail API

Next, do this

Download Attachment with the Gmail (Developer App) API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a Gmail trigger and Gmail (Developer App) action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Attachment Received trigger
1. Configure timer
2. Connect your Gmail account
3. Optional- Configure Search Query
4. Optional- Select one or more Labels
Configure the Download Attachment action
1. Connect your Gmail (Developer App) account
2. Select a Message
3. Select a Attachment
4. Optional- Configure Filename
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Attachment Received on Gmail

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.6

Key:gmail-new-attachment-received

View on GitHub

Gmail Overview#

By connecting your personal Gmail account to Pipedream, you'll be able to incorporate email into whatever you're building with any of the thousands of apps that are available on Pipedream.

Trigger Code#

import gmail from "../../gmail.app.mjs";
import common from "../common/polling-messages.mjs";

export default {
  ...common,
  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.6",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    gmail,
    q: {
      propDefinition: [
        gmail,
        "q",
      ],
    },
    labels: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    constructQuery(lastDate) {
      const { q: query } = this;
      const hasAttachment = query?.includes("has:attachment")
        ? ""
        : "has:attachment";
      const after = !query?.includes("after:") && lastDate
        ? `after:${lastDate / 1000}`
        : "";
      return [
        hasAttachment,
        after,
        query,
      ].join(" ").trim();
    },
    getLabels() {
      return this.labels;
    },
    generateMeta(attachment, message) {
      return {
        id: `${message.id}${attachment.partId}`,
        summary: `New Attachment: ${attachment.filename}`,
        ts: +message.internalDate,
      };
    },
    emitEvent(message) {
      if (message) {
        const { parts: attachments } = message.payload;

        attachments.filter((attachment) => attachment.body.attachmentId).forEach((attachment) => {
          this.$emit({
            message,
            attachment,
          }, this.generateMeta(attachment, message));
        });
      }
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
Gmail	`gmail`	`app`	This component uses the Gmail app.
Search Query	`q`	`string`	Apply a search filter using Gmail's standard search operators
Labels	`labels`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

Gmail uses OAuth authentication. When you connect your Gmail account, Pipedream will open a popup window where you can sign into Gmail and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Gmail API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofileopenidhttps://www.googleapis.com/auth/gmail.labelshttps://www.googleapis.com/auth/gmail.sendhttps://www.googleapis.com/auth/gmail.modifyhttps://www.googleapis.com/auth/gmail.composehttps://www.googleapis.com/auth/gmail.settings.basic

About Gmail#

Gmail offers private and secure email by Google at no cost, for business and consumer accounts.

Action#

Download Attachment on Gmail (Developer App)

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.8

Key:gmail_custom_oauth-download-attachment

View on GitHub

Gmail (Developer App) Overview#

With the Gmail (Developer App) API on Pipedream, you can automate a variety of email-related tasks, directly manipulating your Gmail account to streamline workflows. From sending emails programmatically to parsing new inbound messages for data extraction, the API allows for deep interaction with your Gmail inbox. Use cases include automating follow-ups, organizing your inbox with filters and labels, and synchronizing important email events with other services to act upon new information instantly.

Action Code#

/* eslint-disable pipedream/required-properties-name */
/* eslint-disable pipedream/required-properties-description */
/* eslint-disable pipedream/required-properties-type */
import base from "../../../gmail/actions/download-attachment/download-attachment.mjs";
import overrideApp from "../../common/override-app.mjs";

overrideApp(base);

export default {
  ...base,
  key: "gmail_custom_oauth-download-attachment",
  version: "0.0.8",
  type: "action",
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Gmail (Developer App)	`gmail`	`app`	This component uses the Gmail (Developer App) app.
Message	`messageId`	`string`	Select a value from the drop down menu.
Attachment	`attachmentId`	`string`	Select a value from the drop down menu.
Filename	`filename`	`string`	Name of the new file. Example: `test.jpg`

Action Authentication#

Gmail (Developer App) uses OAuth authentication. When you connect your Gmail (Developer App) account, Pipedream will open a popup window where you can sign into Gmail (Developer App) and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Gmail (Developer App) API.

Pipedream requests the following authorization scopes when you connect your account:

do not use

About Gmail (Developer App)#

Private and secure email by Google at no cost, for business and consumer accounts. Use this app to connect your own developer account credentials.

More Ways to Connect Gmail (Developer App) + Gmail#

Other Popular Integrations#

Add Label to Email with Gmail (Developer App) API on New Attachment Received from Gmail API

Gmail + Gmail (Developer App)

Download Attachment with Gmail (Developer App) API on New Attachment Received from Gmail API

Pipedream makes it easy to connect APIs for Gmail (Developer App), Gmail and 2,400+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular