Gmail
Gmail offers private and secure email by Google at no cost, for business and consumer accounts.
Go to siteGmail API Integrations
Build and run workflows using the Gmail API. Use 1000s of source-available triggers and actions across 2,200+ apps. Or write custom code to integrate any app or API in seconds.
Trusted by 1,000,000+ developers from startups to Fortune 500 companies
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.
import { axios } from "@pipedream/platform"
export default defineComponent({
props: {
gmail: {
type: "app",
app: "gmail",
}
},
async run({steps, $}) {
return await axios($, {
url: `https://www.googleapis.com/oauth2/v1/userinfo`,
headers: {
Authorization: `Bearer ${this.gmail.$auth.oauth_access_token}`,
},
})
},
})
Choose an API to Connect with Gmail API#
1-24of2,200+apps by most popular
Getting Started#
To connect your Gmail account to Pipedream, just accept the prompt when connecting your Gmail account.
What's the difference between the Gmail app and the Gmail Developer App?
Google requires integration platforms such as Pipedream, to restrict the scopes users can enable for Gmail, in order to regulate the ability of users to build workflows and connect applications.
Currently, the Gmail app on Pipedream is limited to only sending emails on behalf of your Gmail email address associated with this app.
However, the Gmail Developer App is unrestricted because you have the ability to control the scopes through creating your own Google Cloud Project.
Because you can define your own scopes, you can read and write emails with your own Google Cloud Project. To learn how to create and authenticate a Gmail Developer App read our setup guide.
Popular Gmail Integrations#
Popular Gmail Triggers#
Emit new event for each attachment in a message received. This source is capped at 100 max new messages per run.
Emit new event when an email matching the search criteria is received. This source is capped at 100 max new messages per run.
Emit new event for each new email sent. (Maximum of 100 events emited per execution)
Popular Gmail Actions#
Create a draft from your Google Workspace email account. See the documentation
Download an attachment by attachmentId to the /tmp directory. See the documentation
Authentication#
Name Slug: gmailGmail 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- authorization
GEThttps://accounts.google.com/o/oauth2/auth?client_id={{oauth.client_id}}&state={{oauth.state}}&redirect_uri={{oauth.redirect_uri}}&response_type=code&scope={{oauth.space_separated_scopes}}&access_type=offline&prompt=consent - accessToken
POSThttps://oauth2.googleapis.com/tokencontent-type:application/x-www-form-urlencodedaccept:application/jsonclient_id={{oauth.client_id}}&client_secret={{oauth.client_secret}}&grant_type=authorization_code&code={{oauth.code}}&redirect_uri={{oauth.redirect_uri}} - refreshToken
POSThttps://oauth2.googleapis.com/tokencontent-type:application/x-www-form-urlencodedaccept:application/jsonclient_id={{oauth.client_id}}&client_secret={{oauth.client_secret}}&grant_type=refresh_token&refresh_token={{oauth.refresh_token}}
Trusted by 1,000,000+ developers from startups to Fortune 500 companies