← Gmail

Send Email with Gmail API

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

Trigger workflow on
HTTP requests, schedules and app events
Next, do this
Send Email with the Gmail API
No credit card required
Intro to Pipedream
Watch us build a workflow
Watch us build a workflow
8 min
Watch now ➜

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

Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo
Adyen logo
Appcues logo
Bandwidth logo
Checkr logo
ChartMogul logo
Dataminr logo
Gopuff logo
Gorgias logo
LinkedIn logo
Logitech logo
Replicated logo
Rudderstack logo
SAS logo
Scale AI logo
Webflow logo
Warner Bros. logo

Developers Pipedream

Getting Started

Create a workflow to Send Email with the Gmail API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

  1. Configure the Send Email action
    1. Connect your Gmail account
    2. Configure To
    3. Optional- Configure Cc
    4. Optional- Configure Bcc
    5. Optional- Configure From Name
    6. Optional- Select a From Email
    7. Optional- Configure Reply To
    8. Configure Subject
    9. Configure Email Body
    10. Optional- Select a Body Type
    11. Optional- Configure Attachment Filenames
    12. Optional- Configure Attachment URLs or Paths
    13. Optional- Configure In Reply To
    14. Optional- Select a Mime Type
  2. Select a trigger to run your workflow on HTTP requests, schedules or app events
  3. Deploy the workflow
  4. Send a test event to validate your setup
  5. Turn on the trigger

Integrations

Send Email with Gmail API on New Email Received from Gmail (Developer App) API
Gmail (Developer App) + Gmail
 
Try it
Send Email with Gmail API on New Requests (Payload Only) from HTTP / Webhook API
HTTP / Webhook + Gmail
 
Try it
Send Email with Gmail API on New Message in Channel from Discord Bot API
Discord Bot + Gmail
 
Try it
Send Email with Gmail API on New Submission from Typeform API
Typeform + Gmail
 
Try it
Send Email with Gmail API on Custom Events from Zoom API
Zoom + Gmail
 
Try it

Details

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is 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.

Send Email on Gmail
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.6
Key:gmail-send-email

Code

import gmail from "../../gmail.app.mjs";
import { ConfigurationError } from "@pipedream/platform";
import utils from "../../common/utils.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.6",
  type: "action",
  props: {
    gmail,
    to: {
      propDefinition: [
        gmail,
        "to",
      ],
    },
    cc: {
      propDefinition: [
        gmail,
        "cc",
      ],
    },
    bcc: {
      propDefinition: [
        gmail,
        "bcc",
      ],
    },
    fromName: {
      propDefinition: [
        gmail,
        "fromName",
      ],
    },
    fromEmail: {
      propDefinition: [
        gmail,
        "fromEmail",
      ],
    },
    replyTo: {
      propDefinition: [
        gmail,
        "replyTo",
      ],
    },
    subject: {
      propDefinition: [
        gmail,
        "subject",
      ],
    },
    body: {
      propDefinition: [
        gmail,
        "body",
      ],
    },
    bodyType: {
      propDefinition: [
        gmail,
        "bodyType",
      ],
    },
    attachmentFilenames: {
      propDefinition: [
        gmail,
        "attachmentFilenames",
      ],
    },
    attachmentUrlsOrPaths: {
      propDefinition: [
        gmail,
        "attachmentUrlsOrPaths",
      ],
    },
    inReplyTo: {
      propDefinition: [
        gmail,
        "inReplyTo",
      ],
    },
    mimeType: {
      propDefinition: [
        gmail,
        "mimeType",
      ],
    },
  },
  async run({ $ }) {
    this.attachmentFilenames = utils.parseArray(this.attachmentFilenames);
    this.attachmentUrlsOrPaths = utils.parseArray(this.attachmentUrlsOrPaths);
    if (this.attachmentFilenames?.length !== this.attachmentUrlsOrPaths?.length) {
      throw new ConfigurationError("Must specify the same number of `Attachment Filenames` and `Attachment URLs or Paths`");
    }
    const opts = await this.gmail.getOptionsToSendEmail($, this);
    const response = await this.gmail.sendEmail(opts);
    $.export("$summary", `Successfully sent email to ${this.to}`);
    return response;
  },
};

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.
LabelPropTypeDescription
GmailgmailappThis component uses the Gmail app.
Totostring[]

Enter a single recipient's email or multiple emails as items in an array.

Ccccstring[]

Enter a single recipient's email or multiple emails as items in an array.

Bccbccstring[]

Enter a single recipient's email or multiple emails as items in an array.

From NamefromNamestring

Specify the name that will be displayed in the "From" section of the email.

From EmailfromEmailstringSelect a value from the drop down menu.
Reply ToreplyTostring

Specify the email address that will appear on the "Reply-To" field, if different than the sender's email.

Subjectsubjectstring

Specify a subject for the email.

Email Bodybodystring

Include an email body as either plain text or HTML. If HTML, make sure to set the "Body Type" prop to html.

Body TypebodyTypestringSelect a value from the drop down menu:htmlplaintext
Attachment FilenamesattachmentFilenamesstring[]

Array of the names of the files to attach. Must contain the file extension (e.g. .jpeg, .txt). Use in conjuction with Attachment URLs or Paths.

Attachment URLs or PathsattachmentUrlsOrPathsstring[]

Array of the URLs of the download links for the files, or the local paths (e.g. /tmp/my-file.txt). Use in conjuction with Attachment Filenames.

In Reply ToinReplyTostring

Specify the message-id this email is replying to. Must be from the first message sent in the thread. To use this prop with async options please use Gmail (Developer App) Send Email component.

Mime TypemimeTypestringSelect a value from the drop down menu.

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 Use Gmail

Triggers

New Attachment Received from the Gmail API

Emit new event for each attachment in a message received. This source is capped at 100 max new messages per run.

 
Try it
New Email Matching Search from the Gmail API

Emit new event when an email matching the search criteria is received. This source is capped at 100 max new messages per run.

 
Try it
New Email Received from the Gmail API

Emit new event when a new email is received.

 
Try it
New Labeled Email from the Gmail API

Emit new event when a new email is labeled.

 
Try it
New Sent Email from the Gmail API

Emit new event for each new email sent. (Maximum of 100 events emited per execution)

 
Try it

Actions

Add Label to Email with the Gmail API

Add label(s) to an email message. See the docs

 
Try it
Create Draft with the Gmail API

Create a draft from your Google Workspace email account. See the documentation

 
Try it
Download Attachment with the Gmail API

Download an attachment by attachmentId to the /tmp directory. See the documentation

 
Try it
Find Email with the Gmail API

Find an email using Google's Search Engine. See the docs

 
Try it
Remove Label from Email with the Gmail API

Remove label(s) from an email message. See the docs

 
Try it

Explore Other Apps

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

HTTP / Webhook
HTTP / Webhook
Get a unique URL where you can send HTTP or webhook requests
Node
Node
Anything you can do with Node.js, you can do in a Pipedream workflow. This includes using most of npm's 400,000+ packages.
Python
Python
Anything you can do in Python can be done in a Pipedream Workflow. This includes using any of the 350,000+ PyPi packages available in your Python powered workflows.
OpenAI (ChatGPT)
OpenAI (ChatGPT)
OpenAI is an AI research and deployment company with the mission to ensure that artificial general intelligence benefits all of humanity. They are the makers of popular models like ChatGPT, DALL-E, and Whisper.
Premium
Salesforce
Salesforce
Web services API for interacting with Salesforce
Premium
HubSpot
HubSpot
HubSpot's CRM platform contains the marketing, sales, service, operations, and website-building software you need to grow your business.
Premium
Zoho CRM
Zoho CRM
Zoho CRM is an online Sales CRM software that manages your sales, marketing, and support in one CRM platform.
Premium
Stripe
Stripe
Stripe powers online and in-person payment processing and financial solutions for businesses of all sizes.
Shopify
Shopify
Shopify is a complete commerce platform that lets anyone start, manage, and grow a business. You can use Shopify to build an online store, manage sales, market to customers, and accept payments in digital and physical locations.
Premium
WooCommerce
WooCommerce
WooCommerce is the open-source ecommerce platform for WordPress.
Premium
Snowflake
Snowflake
A data warehouse built for the cloud
Premium
MongoDB
MongoDB
MongoDB is an open source NoSQL database management program.
Supabase
Supabase
Supabase is an open source Firebase alternative.
MySQL
MySQL
MySQL is an open-source relational database management system.
PostgreSQL
PostgreSQL
PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.
Premium
AWS
AWS
Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.
Premium
Twilio SendGrid
Twilio SendGrid
Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.
Amazon SES
Amazon SES
Amazon SES is a cloud-based email service provider that can integrate into any application for high volume email automation
Premium
Klaviyo
Klaviyo
Email Marketing and SMS Marketing Platform
Premium
Zendesk
Zendesk
Zendesk is award-winning customer service software trusted by 200K+ customers. Make customers happy via text, mobile, phone, email, live chat, social media.
Notion
Notion
Notion is a new tool that blends your everyday work apps into one. It's the all-in-one workspace for you and your team.
Slack
Slack
Slack is a channel-based messaging platform. With Slack, people can work together more effectively, connect all their software tools and services, and find the information they need to do their best work — all within a secure, enterprise-grade environment.
Microsoft Teams
Microsoft Teams
Microsoft Teams has communities, events, chats, channels, meetings, storage, tasks, and calendars in one place.
Schedule
Schedule
Trigger workflows on an interval or cron schedule.