Generate Directions with Mapbox API on New Attachment Received from Gmail API

Pipedream makes it easy to connect APIs for Mapbox, Gmail and 2,900+ other apps remarkably fast.

Trigger workflow on

New Attachment Received from the Gmail API

Next, do this

Generate Directions with the Mapbox 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 Mapbox 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. Connect your Gmail account
2. Configure info
3. Configure timer
4. Optional- Configure Search Query
5. Optional- Select one or more Labels
6. Configure Return payload as plaintext
7. Optional- Configure Include Link
8. Optional- Configure dir
Configure the Generate Directions action
1. Connect your Mapbox account
2. Configure Start Coordinate
3. Configure End Coordinate
4. Select a Transportation Mode
5. Optional- Configure Steps
6. Optional- Configure Alternatives
7. Optional- Select one or more Exclude
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.2.1

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 utils from "../../common/utils.mjs";
import gmail from "../../gmail.app.mjs";
import common from "../common/polling-messages.mjs";
import { Readable } from "stream";

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.2.1",
  type: "source",
  dedupe: "unique",
  props: {
    gmail,
    info: {
      type: "alert",
      alertType: "info",
      content: "Note: May not emit events for attachments sent via a Gmail alias. [See issue](https://github.com/PipedreamHQ/pipedream/issues/15309) for more information.",
    },
    ...common.props,
    q: {
      propDefinition: [
        gmail,
        "q",
      ],
    },
    labels: {
      propDefinition: [
        gmail,
        "label",
      ],
      type: "string[]",
      label: "Labels",
      optional: true,
    },
    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,
    },
    includeLink: {
      label: "Include Link",
      type: "boolean",
      description: "Upload attachment to your File Stash and emit temporary download link to the file. See [the docs](https://pipedream.com/docs/connect/components/files) to learn more about working with files in Pipedream.",
      default: false,
      optional: true,
    },
    dir: {
      type: "dir",
      accessMode: "write",
      optional: true,
    },
  },
  methods: {
    ...common.methods,
    constructQuery(lastDate) {
      const hasAttachment = "has:attachment";
      if (!this.q) {
        this.q = hasAttachment;
      } else if (!this.q.includes(hasAttachment)) {
        this.q = `${this.q} ${hasAttachment}`;
      }
      return common.methods.constructQuery.call(this, lastDate);
    },
    getLabels() {
      return this.labels;
    },
    generateMeta(attachment, message) {
      return {
        id: `${message.id}${attachment.partId}`,
        summary: `New Attachment: ${attachment.filename}`,
        ts: +message.internalDate,
      };
    },
    /**
     * Downloads a specific attachment from a Gmail message, uploads it to this
     * source's File Stash folder, and returns the upload details.
     * @param {string} messageId - The ID of the message containing the attachment.
     * @param {Object} attachment - The attachment metadata.
     * @returns {Promise<{path: string, get_url: string, s3Key: string}>} - The
     * uploaded file details.
     */
    async stashAttachment(messageId, attachment) {
      const attachmentId = attachment.body.attachmentId;
      // Download the attachment from Gmail
      const messageAttachment =  await this.gmail.getAttachment({
        messageId,
        attachmentId,
      });
      const buffer = Buffer.from(messageAttachment.data, "base64");
      // Construct a file path unique to this attachment to avoid overwriting
      // files with the same name.
      const filepath = `${messageId}-${attachment.partId}/${attachment.filename}`;
      // Upload the attachment to the configured directory (File Stash) so it
      // can be accessed later.
      const file = await this.dir.open(filepath).fromReadableStream(
        Readable.from(buffer),
        attachment.mimeType,
        attachment.size,
      );
      // Return file details and temporary download link:
      // { path, get_url, s3Key, type }
      return await file.withoutPutUrl().withGetUrl();
    },
    async emitEvent(message) {
      if (message) {
        const { parts: attachments = [] } = message.payload;
        const parsedMessage = utils.validateTextPayload(message, this.withTextPayload);

        for (const attachment of attachments.filter((attachment) => attachment.body.attachmentId)) {
          const event = {
            message: parsedMessage || message,
            attachment,
          };
          if (this.includeLink) {
            event.file = await this.stashAttachment(message.id, attachment);
          }
          this.$emit(event, 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
Gmail	`gmail`	`app`	This component uses the Gmail app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
	`timer`	`$.interface.timer`
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.
Return payload as plaintext	`withTextPayload`	`boolean`	Convert the payload response into a single text field. This reduces the size of the payload and makes it easier for LLMs work with.
Include Link	`includeLink`	`boolean`	Upload attachment to your File Stash and emit temporary download link to the file. See the docs to learn more about working with files in Pipedream.
	`dir`	`dir`

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#

Generate Directions on Mapbox

Description:Generates directions between two or more locations using Mapbox API. [See the documentation](https://docs.mapbox.com/api/navigation/directions/).

Version:0.0.2

Key:mapbox-generate-directions

View on GitHub

Mapbox Overview#

The Mapbox API offers a suite of tools for developers to integrate location-based services into their applications. With Pipedream, you can leverage Mapbox's capabilities to create complex automations and workflows, like real-time mapping, geocoding, and route optimization. Whether you're managing delivery routes, analyzing spatial data, or personalizing user experiences based on location, Mapbox provides the geographical intelligence that, when combined with Pipedream's serverless platform, can turn these ideas into efficient, automated processes.

Action Code#

import mapbox from "../../mapbox.app.mjs";

export default {
  key: "mapbox-generate-directions",
  name: "Generate Directions",
  description: "Generates directions between two or more locations using Mapbox API. [See the documentation](https://docs.mapbox.com/api/navigation/directions/).",
  version: "0.0.2",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  type: "action",
  props: {
    mapbox,
    startCoordinate: {
      type: "string",
      label: "Start Coordinate",
      description: "The starting point in the format `longitude,latitude`, E.g. `-85.244869,37.835819`",
    },
    endCoordinate: {
      type: "string",
      label: "End Coordinate",
      description: "The ending point in the format `longitude,latitude`, E.g. `-85.244869,37.835819`",
    },
    transportationMode: {
      propDefinition: [
        mapbox,
        "transportationMode",
      ],
    },
    steps: {
      type: "boolean",
      label: "Steps",
      description: "Whether to return steps and turn-by-turn instructions (`true`) or not (`false`, default)",
      optional: true,
    },
    alternatives: {
      type: "boolean",
      label: "Alternatives",
      description: "Whether to try to return alternative routes (`true`) or not (`false`, default). An alternative route is a route that is significantly different from the fastest route, but still close in time.",
      optional: true,
    },
    exclude: {
      propDefinition: [
        mapbox,
        "exclude",
      ],
    },
  },
  async run({ $ }) {
    const directions = await this.mapbox.getDirections({
      $,
      transportationMode: this.transportationMode,
      coordinates: `${this.startCoordinate};${this.endCoordinate}`,
      params: {
        steps: this.steps,
        alternatives: this.alternatives,
        exclude: this.exclude && this.exclude.join(","),
      },
    });
    $.export("$summary", "Generated directions successfully.");
    return directions;
  },
};

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
Mapbox	`mapbox`	`app`	This component uses the Mapbox app.
Start Coordinate	`startCoordinate`	`string`	The starting point in the format `longitude,latitude`, E.g. `-85.244869,37.835819`
End Coordinate	`endCoordinate`	`string`	The ending point in the format `longitude,latitude`, E.g. `-85.244869,37.835819`
Transportation Mode	`transportationMode`	`string`	Select a value from the drop down menu:`drivingwalkingcyclingdriving-traffic`
Steps	`steps`	`boolean`	Whether to return steps and turn-by-turn instructions (`true`) or not (`false`, default)
Alternatives	`alternatives`	`boolean`	Whether to try to return alternative routes (`true`) or not (`false`, default). An alternative route is a route that is significantly different from the fastest route, but still close in time.
Exclude	`exclude`	`string[]`	Select a value from the drop down menu:`motorwaytollferryunpavedcash_only_tollscountry_borderstate_border`

Action Authentication#

Mapbox uses API keys for authentication. When you connect your Mapbox account, Pipedream securely stores the keys so you can easily authenticate to Mapbox APIs in both code and no-code steps.

Generate and copy your Access Toke from your Mapbox dashboard.

About Mapbox#

Mapbox powers navigation for people, packages, and vehicles everywhere.

More Ways to Connect Mapbox + Gmail#

Other Popular Integrations#

Generate Directions with Mapbox API on New Email Matching Search from Gmail API

Gmail + Mapbox

Generate Directions with Mapbox API on New Attachment Received from Gmail API

Pipedream makes it easy to connect APIs for Mapbox, Gmail and 2,900+ other apps remarkably fast.

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

Developers ♥ Pipedream

1-24of2,900+apps by most popular

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