Download Attachment with Gmail API on New Upcoming Event Alert from Google Calendar API

Pipedream makes it easy to connect APIs for Gmail, Google Calendar and 2,400+ other apps remarkably fast.

Trigger workflow on

New Upcoming Event Alert from the Google Calendar API

Next, do this

Download Attachment with the Gmail 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 Google Calendar trigger and Gmail action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Upcoming Event Alert trigger
1. Connect your Google Calendar account
2. Connect your Google Calendar account
3. Optional- Select a Calendar ID
4. Optional- Select one or more Event Types
5. Configure Minutes Before
Configure the Download Attachment action
1. Connect your Gmail 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 Upcoming Event Alert on Google Calendar

Description:Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler. [See the documentation](https://pipedream.com/docs/examples/waiting-to-execute-next-step-of-workflow/#step-1-create-a-task-scheduler-event-source) for more information and instructions for connecting your Pipedream account.

Version:0.0.9

Key:google_calendar-upcoming-event-alert

View on GitHub

Google Calendar Overview#

The Google Calendar API lets you dip into the powerhouse of scheduling, allowing for the reading, creation, and manipulation of events and calendars directly from your applications. Through Pipedream, you can seamlessly integrate Google Calendar into a myriad of workflows, automating event management, syncing with other services, setting up custom reminders, or even collating data for reporting. The key here is to streamline your calendar-related processes, ensuring that your time management is as efficient and automated as possible.

Trigger Code#

import taskScheduler from "../../../pipedream/sources/new-scheduled-tasks/new-scheduled-tasks.mjs";
import googleCalendar from "../../google_calendar.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "google_calendar-upcoming-event-alert",
  name: "New Upcoming Event Alert",
  description: `Emit new event based on a time interval before an upcoming event in the calendar. This source uses Pipedream's Task Scheduler.
    [See the documentation](https://pipedream.com/docs/examples/waiting-to-execute-next-step-of-workflow/#step-1-create-a-task-scheduler-event-source) 
    for more information and instructions for connecting your Pipedream account.`,
  version: "0.0.9",
  type: "source",
  props: {
    pipedream: taskScheduler.props.pipedream,
    googleCalendar,
    db: "$.service.db",
    http: "$.interface.http",
    calendarId: {
      propDefinition: [
        googleCalendar,
        "calendarId",
      ],
    },
    eventTypes: {
      propDefinition: [
        googleCalendar,
        "eventTypes",
      ],
    },
    time: {
      type: "integer",
      label: "Minutes Before",
      description: "Number of minutes to trigger before the start of the calendar event.",
      min: 0,
      reloadProps: true,
    },
  },
  async additionalProps() {
    const props = {};
    if (this.time > 0) {
      props.timer = {
        type: "$.interface.timer",
        description: "Poll the API to schedule alerts for any newly created events",
        default: {
          intervalSeconds: 60 * this.time,
        },
      };
    }
    return props;
  },
  hooks: {
    async deactivate() {
      const ids = this._getScheduledEventIds();
      if (!ids?.length) {
        return;
      }
      for (const id of ids) {
        if (await this.deleteEvent({
          body: {
            id,
          },
        })) {
          console.log("Cancelled scheduled event");
        }
      }
      this._setScheduledEventIds();
    },
  },
  methods: {
    ...taskScheduler.methods,
    _getScheduledEventIds() {
      return this.db.get("scheduledEventIds");
    },
    _setScheduledEventIds(ids) {
      this.db.set("scheduledEventIds", ids);
    },
    _getScheduledCalendarEventIds() {
      return this.db.get("scheduledCalendarEventIds");
    },
    _setScheduledCalendarEventIds(ids) {
      this.db.set("scheduledCalendarEventIds", ids);
    },
    _hasDeployed() {
      const result = this.db.get("hasDeployed");
      this.db.set("hasDeployed", true);
      return result;
    },
    subtractMinutes(date, minutes) {
      return date.getTime() - minutes * 60000;
    },
    async getCalendarEvents() {
      const calendarEvents = [];
      const params = {
        returnOnlyData: false,
        calendarId: this.calendarId,
        eventTypes: this.eventTypes,
      };
      do {
        const {
          data: {
            items, nextPageToken,
          },
        } = await this.googleCalendar.listEvents(params);
        if (items?.length) {
          calendarEvents.push(...items);
        }
        params.pageToken = nextPageToken;
      } while (params.pageToken);
      return calendarEvents;
    },
  },
  async run(event) {
    // self subscribe only on the first time
    if (!this._hasDeployed()) {
      await this.selfSubscribe();
    }

    const scheduledEventIds = this._getScheduledEventIds() || [];

    // incoming scheduled event
    if (event.$channel === this.selfChannel()) {
      const remainingScheduledEventIds = scheduledEventIds.filter((id) => id !== event["$id"]);
      this._setScheduledEventIds(remainingScheduledEventIds);
      this.emitEvent(event, `Upcoming ${event.summary} event`);
      return;
    }

    // schedule new events
    const scheduledCalendarEventIds = this._getScheduledCalendarEventIds() || {};
    const calendarEvents = await this.getCalendarEvents();

    for (const calendarEvent of calendarEvents) {
      const startTime = calendarEvent.start
        ? (new Date(calendarEvent.start.dateTime || calendarEvent.start.date))
        : null;
      if (!startTime
        || startTime.getTime() < Date.now()
        || scheduledCalendarEventIds[calendarEvent.id])
      {
        continue;
      }
      const later = new Date(this.subtractMinutes(startTime, this.time));

      const scheduledEventId = this.emitScheduleEvent(calendarEvent, later);
      scheduledEventIds.push(scheduledEventId);
      scheduledCalendarEventIds[calendarEvent.id] = true;
    }
    this._setScheduledEventIds(scheduledEventIds);
    this._setScheduledCalendarEventIds(scheduledCalendarEventIds);
  },
  sampleEmit,
};

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
Google Calendar	`pipedream`	`app`	This component uses the Google Calendar app.
Google Calendar	`googleCalendar`	`app`	This component uses the Google Calendar app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
N/A	`http`	`$.interface.http`	This component uses `$.interface.http` to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the `run()` method of the component.
Calendar ID	`calendarId`	`string`	Select a value from the drop down menu.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu:`defaultfocusTimeoutOfOfficeworkingLocation`
Minutes Before	`time`	`integer`	Number of minutes to trigger before the start of the calendar event.

Trigger Authentication#

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

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

https://www.googleapis.com/auth/calendar.eventshttps://www.googleapis.com/auth/calendar.readonlyhttps://www.googleapis.com/auth/calendar.settings.readonly

About Google Calendar#

With Google Calendar, you can quickly schedule meetings and events and get reminders about upcoming activities, so you always know what’s next.

Action#

Download Attachment on Gmail

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

Key:gmail-download-attachment

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.

Action Code#

import gmail from "../../gmail.app.mjs";
import fs from "fs";
import path from "path";
import { ConfigurationError } from "@pipedream/platform";

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.4",
  type: "action",
  props: {
    gmail,
    messageId: {
      propDefinition: [
        gmail,
        "messageWithAttachments",
      ],
    },
    attachmentId: {
      propDefinition: [
        gmail,
        "attachmentId",
        ({ messageId }) => ({
          messageId,
        }),
      ],
      withLabel: true,
    },
    filename: {
      type: "string",
      label: "Filename",
      description: "Name of the new file. Example: `test.jpg`",
      optional: true,
    },
  },
  async run({ $ }) {
    const attachmentId = this.attachmentId.value || this.attachmentId;

    const attachment = await this.gmail.getAttachment({
      messageId: this.messageId,
      attachmentId,
    });

    const filename = this.filename || this.attachmentId.label;
    if (!filename) {
      throw new ConfigurationError("Please enter a filename to save the downloaded file as in the `/tmp` directory.");
    }

    const filePath = path.join("/tmp", filename);
    const buffer = Buffer.from(attachment.data, "base64");
    fs.writeFileSync(filePath, buffer);

    $.export("$summary", `Successfully created file ${filename} in \`/tmp\` directory`);

    return {
      filename,
      filePath,
    };
  },
};

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	`gmail`	`app`	This component uses the Gmail 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 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.

More Ways to Connect Gmail + Google Calendar#

Other Popular Integrations#

List Calendar Events by Type with Google Calendar API on New Labeled Email from Gmail API

Gmail + Google Calendar

Download Attachment with Gmail API on New Upcoming Event Alert from Google Calendar API

Pipedream makes it easy to connect APIs for Gmail, Google Calendar 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