Gmail

  • Reference

Gmail is a web-based email service from Google. With the Gmail connector, you lot tin perform actions such as send or receive e-mail messages, and trigger flows on new e-mails.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
-   Azure China regions
-   Usa Department of Defense (DoD)
Power Automate Standard All Ability Automate regions except the following:
-   The states Government (GCC High)
-   People's republic of china Cloud operated by 21Vianet
-   US Department of Defence (DoD)
Ability Apps Standard All Ability Apps regions except the following:
-   Usa Government (GCC High)
-   China Cloud operated by 21Vianet
-   Us Department of Defence force (DoD)
Contact
Proper noun Microsoft
URL Microsoft LogicApps Support
Microsoft Ability Automate Support
Microsoft Power Apps Back up
Connector Metadata
Publisher Microsoft
Website https://postal service.google.com/post/
Privacy policy https://policies.google.com/privacy

Authentication and Bring your ain application

The Gmail connector now supports multiple authentication types:

  • Employ default shared application
  • Bring your own awarding

The default shared application uses a Google Client application maintained by Microsoft. In this case, when you sign into your Gmail account, yous'll exist asked to consent to the Microsoft Power Platform application.

With "Bring your own application" option, you can use your own Google OAuth Client application instead of the i managed by Microsoft. Doing and so will allow you lot to command permissions and enable certain limitations on the employ of the connector.

To employ your own Google OAuth Client application with the Gmail connector, you'll demand to perform the following steps:

  1. Create an OAuth client application using Google's API Console
  2. Use the application in the Gmail connector

Creating an OAuth Customer Application in Google

To create your ain Google OAuth client application, you'll demand to showtime sign in to https://developer.google.com. Navigate to Google's API Console — which is where yous tin manage access to Google APIs — and create the OAuth application. This process is explained in Google'south Gmail API Developer Guide. Google provides a setup tool to guide you through the process of creating a project for y'all, enable the Gmail API for your project, and create an OAuth client awarding and the credentials for information technology. Here's some information you'll discover useful when going through the tool:

  • Read and agree to the Terms of Service if needed.
  • Select an existing project, or the tool volition create a new one chosen "My Projection".
  • The tool volition enable the Gmail API in the project.
  • The tool volition try to find out the credential type you demand. You'll need to get an OAuth Client awarding.
    • Select Gmail API for the API you'll exist using (if not already selected).
    • Select Spider web server for the where y'all'll be calling the API from.
    • Select User data for the data you'll be accessing.
  • The tool will walk you through the set an OAuth consent screen.
    • Select the user type (Internal or External). If y'all are using a Gmail consumer account, you cannot select Internal.
    • Provide a name and, optionally, a logo for your application.
    • Click on Add Telescopic and add the Gmail scope (https://mail.google.com).

      Annotation

      Based on your usage demand, you can select an appropriate subset of the permission scopes hither.

    • Add azure-apim.internet as one of the authorized domains.

      Notation

      This is the domain on which the Gmail connector is hosted, as divers hither.

    • Optionally, provide the other information.
  • The tool will let you define and add an OAuth 2.0 client credential.
    • Provide a name for your OAuth Customer awarding.
    • Add together "https://global.consent.azure-apim.net/redirect" for the Redirect URI.

Once yous're done, navigate to the created OAuth customer from the Credentials page. You lot'll detect the Client ID and the Client hush-hush of your app. You lot can now use those values in your Gmail connection.

Google OAuth Client

Using your own application in the Gmail connector

Once y'all create the Google OAuth client application, y'all can employ it while creating a Gmail connection.

  • Select Bring your own application.
  • Specify the Client ID and Client secret values from your awarding.

Click on Sign in to sign into your Gmail business relationship. This will prompt you to sign in to your Gmail account, and and so authorize admission to the Google app that y'all created above.

Known issues and limitations

Trigger limitations for large number of incoming emails

The When a new e-mail arrives trigger may skip emails if you lot are receiving more than 300 emails per 30 seconds interval. Consider configuring your flow with boosted filter parameters to reduce number of emails.

The When a new email arrives trigger may intermittently skip emails with attachments if you lot are using a Google Workspace (formerly M Suite) account. This happens because in some case Gmail API takes a long time to process emails (perchance due to security scans of attachments), so the emails are received with a certain delay.

As possible workaround please effort the following:

  • Apply tiny emails (without attachments), endeavor to ship them non so frequently

  • Use another consumer Gmail business relationship and configure automobile-forwarding from the Google Workspace business relationship to this new consumer Gmail business relationship. Configure the trigger against this new account. Since this is a consumer account, we believe that the filibuster will exist minimized and the trigger will not skip such emails.

  • Use a custom connector to ListMessage API with a q parameter:

    • Create an action to listing messages for the last 5 minutes. You can do so using q parameter. Example of q param value - after:1649457986. You lot should provide electric current time - 5min epoch fourth dimension as the action input.

      • 1649457986 is the epoch time that represents "Friday, Apr eight, 2022 3:46:26 PM GMT-07:00".

    • Cheque nextPageToken value from the response until information technology is empty. If it is not empty then you need to phone call the same API with pageToken parameter value set to the nextPageToken from the response. You can do so using "Until" loop for example.

    • Filter out those messages IDs which have already been processed in previous runs (eastward.g. y'all can employ Azure Tabular array Storage connector to store already processed IDs)

    • Use Get email details activity to get email content by ID

Using Gmail connector with consumer Gmail accounts

In compliance with Google's security and privacy policy, customers using consumer Gmail accounts (Accounts ending in @gmail.com and @googlemail.com) tin only connect to a limited set of services within Ability Automate and Logic Apps. Customers using Google Workspace (formerly G Suite) accounts are non impacted by this change. If you demand to apply the Gmail connector with services non specified in the below list you will need to register your own Awarding id with Google. Below is the list of the electric current canonical services, practice note that this list is subject area to change in the time to come in accordance with Google'southward policies:

  • Google services: Gmail, Google Calendar, Google Contacts, Google Drive, Google Sheets, Google Tasks
  • Built in actions and triggers: Control, AI Builder, Data operations, Appointment Time, Number Functions, Power Virtual Agents, Ability Apps, Request, Schedule, Text Functions, Variables, Flow button, Location
  • Limited set up of Microsoft services: OneDrive, Sharepoint, Excel, Dynamics, Microsoft Teams, Office 365, SQL, SFTP and FTP

In Power Automate if you create a flow with a not-compliant service the menstruation will finish up beingness saved in a disabled state.

Computing piece of work units

The connector has a throttling limit (refer here) on the number of work units that can exist consumed in a mean solar day.

The logic on how these work units are calculated for each operation is shown below:

  • When a new e-mail arrives trigger : ten + (5 * attachmentsCount);
    • If trigger returns new email: 5 units to list letters + 5 units to get message + 5 units * attachments count.
    • If trigger doesn't return new e-mail: 5 units to listing messages.
  • Transport email (V2) activity : 100 units.
  • Reply to email (V2) activity : 105 + (5 * attachmentsCount);
    • 5 units to get original bulletin + 100 units to send respond message + 5 units * inline attachments count in original message.
  • For all other actions: 10 units.

Connector in-depth

For more information near the connector, see the in-depth section.

General Limits

Proper noun Value
Maximum postal service size (in MB) 35
Maximum attachment size (in MB) 30

Creating a connection

The connector supports the post-obit hallmark types:
Bring your own application Sign in using your own Google app. For more details see https://docs.microsoft.com/connectors/gmail/#authentication-and-bring-your-own-application. All regions Not shareable
Apply default shared application Sign in using the standard Google app. All regions Non shareable
Default [DEPRECATED] This option is only for older connections without an explicit authentication type, and is merely provided for backward compatibility. All regions Non shareable

Bring your own application

Auth ID: byoa

Applicative: All regions

Sign in using your own Google app. For more details run into https://docs.microsoft.com/connectors/gmail/#authentication-and-bring-your-ain-awarding.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Proper noun Type Description Required
Client ID string Client (or Application) ID of your Google application Truthful
Client Secret securestring Customer clandestine of your Google application True

Utilize default shared application

Auth ID: shared-application

Applicable: All regions

Sign in using the standard Google app.

This is not shareable connection. If the ability app is shared with another user, another user volition exist prompted to create new connection explicitly.

Default [DEPRECATED]

Applicative: All regions

This choice is only for older connections without an explicit authentication type, and is merely provided for backward compatibility.

This is not shareable connectedness. If the power app is shared with some other user, another user will be prompted to create new connexion explicitly.

Throttling Limits

Name Calls Renewal Period
API calls per connectedness 60 60 seconds
Work units per day 90000 86400 seconds

Actions

Delete electronic mail

This operation is used to delete a specific electronic mail permanently.
Go email details

This operation retrieves the details of a specific email.
Motion e-mail to trash

This operation is used to motility a specific electronic mail to trash.
Reply to electronic mail (V2)

This operation is used to answer to a specific email.
Reply to e-mail [DEPRECATED]

This action has been deprecated. Please use Reply to electronic mail (V2) instead.

This operation is used to reply to a specific e-mail.

Ship electronic mail (V2)

This functioning is used to send an email to specific recipients.
Transport email [DEPRECATED]

This action has been deprecated. Delight utilize Send electronic mail (V2) instead.

This functioning is used to send an email to specific recipients.

Delete e-mail

This operation is used to delete a specific email permanently.

Parameters

Proper noun Key Required Type Clarification
Message ID
 id True cord

Id of the email to delete.

Get email details

This functioning retrieves the details of a specific email.

Parameters

Name Primal Required Type Description
Message ID
 id True string

Unique id of the electronic mail message.
Include Attachments
 includeAttachments boolean

If set to truthful, attachments will also exist retrieved along with the email.

Returns

Details associated with a specific email bulletin.

Move electronic mail to trash

This functioning is used to move a specific email to trash.

Parameters

Name Fundamental Required Type Description
Bulletin ID
 id True string

ID of the email to move to the trash.

Reply to email (V2)

This operation is used to respond to a specific email.

Parameters

Name Primal Required Type Clarification
Bulletin ID
 id True string

Id of the email to reply to.
To
 To email

Example: recipient1@domain.com; recipient2@domain.com
CC
 Cc email

Instance: recipient1@domain.com; recipient2@domain.com
BCC
 Bcc email

Example: recipient1@domain.com; recipient2@domain.com
Bailiwick
 Subject string

Email discipline (if empty, the original field of study used).
Body
 Trunk html

Content of the electronic mail.
Reply All
 ReplyAll boolean

True to reply to all recipients. (default: False)
Importance
 Importance cord

Selection an importance. (default: Normal)
Name
 Name True string

Title of the attachment.
Content
 ContentBytes Truthful byte

Body of the attachment.
Content-Type
 ContentType string

Type of content in the zipper.

Answer to email [DEPRECATED]

This action has been deprecated. Please use Answer to electronic mail (V2) instead.

This operation is used to reply to a specific e-mail.

Parameters

Name Primal Required Blazon Clarification
Message ID
 id True string

Id of the email to answer to.
To
 To email

Example: recipient1@domain.com; recipient2@domain.com
CC
 Cc email

Example: recipient1@domain.com; recipient2@domain.com
BCC
 Bcc email

Example: recipient1@domain.com; recipient2@domain.com
Subject
 Subject field string

Email subject (if empty, the original subject used).
Torso
 Body string

Content of the electronic mail.
Reply All
 ReplyAll boolean

True to respond to all recipients. (default: False)
Is HTML
 IsHtml boolean

True to transport the answer every bit HTML. (default: Truthful)
Importance
 Importance string

Pick an importance. (default: Normal)
Name
 Proper name Truthful string

Title of the attachment.
Content
 ContentBytes True byte

Torso of the zipper.
Content-Type
 ContentType string

Type of content in the attachment.

Send e-mail (V2)

This operation is used to send an electronic mail to specific recipients.

Parameters

Proper name Key Required Type Description
To
 To True email

A list of valid email addresses separated past a semicolon or a comma.
CC
 Cc email

A list of valid email addresses separated by a semicolon or a comma.
BCC
 Bcc e-mail

A list of valid e-mail addresses separated by a semicolon or a comma.
Subject
 Bailiwick string

Subject of the approachable e-mail.
Body
 Body html

Body of the outgoing email.
Importance
 Importance string

Importance associated with the email message.
Proper name
 Name Truthful string

Title of the attachment.
Content
 ContentBytes True byte

Body of the zipper.
Content-Type
 ContentType cord

Type of content in the zipper.

Send email [DEPRECATED]

This action has been deprecated. Please utilize Send email (V2) instead.

This operation is used to send an email to specific recipients.

Parameters

Name Key Required Type Description
To
 To Truthful email

A listing of valid email addresses separated by a semicolon or a comma.
CC
 Cc email

A list of valid email addresses separated by a semicolon or a comma.
BCC
 Bcc e-mail

A list of valid email addresses separated by a semicolon or a comma.
Subject
 Subject field string

Subject of the approachable e-mail.
Body
 Body string

Trunk of the outgoing e-mail.
Is HTML
 IsHtml boolean

Truthful to ship the email as HTML. (default: True)
Importance
 Importance string

Importance associated with the email message.
Proper noun
 Name True string

Title of the attachment.
Content
 ContentBytes Truthful byte

Torso of the attachment.
Content-Blazon
 ContentType string

Blazon of content in the zipper.

Triggers

When a new email arrives

This operation triggers when a new e-mail matching the specified criteria arrives.

When a new e-mail arrives

This functioning triggers when a new electronic mail matching the specified criteria arrives.

Parameters

Proper noun Central Required Blazon Description
Label
 characterization cord

Choice a label (default: Inbox).
To
 to email

A list of valid email addresses separated by a semicolon or a comma.
From
 from email

Case: Sender1 | sender2@domain.com.
Subject field
 subject string

String to expect for in the subject.
Importance
 importance string

Truthful if the email should be important. (default: All).
Starred
 starred string

True if the email should be starred. (default: All).
Has Attachments
 fetchOnlyWithAttachments boolean

True to retrieve only emails with attachments.
Include Attachments
 includeAttachments boolean

True to remember attachments along with the email.

Returns

Details associated with a specific electronic mail message.

Definitions

DetailedReceiveMessage

Details associated with a specific email message.

Name Path Blazon Description
From
 From email

Email address the message was sent from.
Sender'due south Name
 SenderName cord

Email sender's name
To
 To e-mail

Email address the bulletin was sent to.
CC
 Cc email

Email addresses contained in the CC field.
BCC
 Bcc electronic mail

Electronic mail addresses contained in the BCC field.
Subject field
 Field of study string

Subject or topic associated with the email message.
Torso
 Body cord

Content of the email message.
Snippet
 Snippet cord

A brusk part of the bulletin text.
Characterization IDs
 LabelIds array of cord

List of labels associated with the electronic mail message.
Received Appointment-Time
 DateTimeReceived date-time

Example:2017-05-03T20:08:57+00:00
Estimated Size
 EstimatedSize integer

Estimated size in bytes of the message.
Is Read?
 IsRead boolean

True if the message is read; imitation otherwise.
Is HTML
 IsHtml boolean

True if the bulletin is in HTML format.
Has Attachments
 HasAttachments boolean

True if the message has attachments.
Attachments
 Attachments array of Attachment

List of attachments to the electronic mail message.
Message ID
 Id string

The immutable ID of the bulletin.
Thread ID
 ThreadId string

The ID of the thread the message belongs to.

Attachment

Properties of an email attachment.

Proper noun Path Type Description
Name
 Name string

Title of the attachment.
Content
 ContentBytes byte

Torso of the attachment.
Content-Type
 ContentType string

Type of content in the zipper.