# mulesoft Gmail Connector - Full Documentation --- product: Gmail Connector version: 1.0 --- # Gmail Connector 1.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Gmail (Gmail Connector) enables the management of your Gmail account, including sending and receiving emails and reacting to received emails. For information about compatibility and fixed issues, see the Gmail Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Gmail Connector’s API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Studio Before creating an app, you must have: - Credentials to access the Gmail target resource - Anypoint Platform - Anypoint Studio version 7.0 or later ## Common Use Cases For the Connector Some possible uses for this connector include: - Sending an email to thank customers for a new purchase. - Organizing all emails related to an event. - Receiving attachments via email to verify an ID. ## Connection Types Gmail connections use the Oauth2c authentication type, which uses access tokens provided by the authorization server to access protected data. For information about configuring authentication types, see [Using Anypoint Studio to Configure Gmail Connector](https://docs.mulesoft.com/gmail-connector/1.0/gmail-connector-studio). ## Next Step After you complete the prerequisites, you are ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/gmail-connector/1.0/gmail-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Gmail Connector Reference](https://docs.mulesoft.com/gmail-connector/1.0/gmail-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Gmail Connector version: 1.0 --- # Gmail Connector 1.0 - XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio: - If you manually code a Mule runtime engine (Mule) app in XML either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `mule` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/gmail http://www.mulesoft.org/schema/mule/gmail/current/mule-gmail.xsd ``` This example shows how the namespace statements are placed in the XML: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors mule4-gmail-connector x.x.x mule-plugin ``` Replace `` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `Gmail`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Gmail Connector version: 1.0 --- # Gmail Connector 1.0 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Gmail (Gmail Connector) enables the management of your Gmail account, including sending and receiving emails and reacting to received emails. ## Default Configuration ### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection types for this configuration.

x

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

AUTO

Name

String

ID used to reference this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

### Connection Types #### Oauth2c Connection Provider Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). ##### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Query Parameters

Connection Timeout

Number

How long the connector waits before timing out when initially establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

* true

Mule uses persistent connections.

* false

Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Access Type

String

Access type.

offline

Base Uri

String

Parameter base URI. Each instance or tenant gets its own.

https://www.googleapis.com

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Consumer Key

String

OAuth consumer key, as registered with the service provider.

x

Consumer Secret

String

OAuth consumer secret, as registered with the service provider.

x

Authorization Url

String

URL of the service provider’s authorization endpoint.

https://accounts.google.com/o/oauth2/auth

Access Token Url

String

URL of the service provider’s access token endpoint.

https://accounts.google.com/o/oauth2/token

Scopes

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation. Valid values are:

  • <Scope 1>

  • <Scope 2>

  • https://mail.google.com/

  • https://www.googleapis.com/auth/gmail.addons.current.action.compose

  • https://www.googleapis.com/auth/gmail.addons.current.message.action

  • https://www.googleapis.com/auth/gmail.addons.current.message.metadata

  • https://www.googleapis.com/auth/gmail.addons.current.message.readonly

  • https://www.googleapis.com/auth/gmail.compose

  • https://www.googleapis.com/auth/gmail.insert

  • https://www.googleapis.com/auth/gmail.labels

  • https://www.googleapis.com/auth/gmail.metadata

  • https://www.googleapis.com/auth/gmail.modify

  • https://www.googleapis.com/auth/gmail.readonly

  • https://www.googleapis.com/auth/gmail.send

Resource Owner Id

String

Resource owner ID to use with the authorization code grant type.

Before

String

Name of the flow to execute immediately before starting the OAuth dance.

After

String

Name of the flow to execute immediately after receiving an accessToken.

Listener Config

String

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

## Operations - [Create Draft](#CreateDraft) - [Delete Draft](#Gmailusersdraftsdelete) - [Get Draft](#Gmailusersdraftsget) - [List Drafts](#Gmailusersdraftslist) - [Send Draft](#Gmailusersdraftssend) - [Update Draft](#Gmailusersdraftsupdate) - [Get Profile](#GmailusersgetProfile) - [List History](#Gmailusershistorylist) - [Create Label](#Gmailuserslabelscreate) - [Delete Label](#Gmailuserslabelsdelete) - [Get Label](#Gmailuserslabelsget) - [List Labels](#Gmailuserslabelslist) - [Patch Label](#Gmailuserslabelspatch) - [Update Label](#Gmailuserslabelsupdate) - [Get Message Attachment](#Gmailusersmessagesattachmentsget) - [Batch Delete Messages](#GmailusersmessagesbatchDelete) - [Batch Modify Messages](#GmailusersmessagesbatchModify) - [Delete Message](#Gmailusersmessagesdelete) - [Get Message](#Gmailusersmessagesget) - [Import Message](#Gmailusersmessagesimport) - [Insert Message](#Gmailusersmessagesinsert) - [List Messages](#Gmailusersmessageslist) - [Modify Message Labels](#Gmailusersmessagesmodify) - [Send Message](#Gmailusersmessagessend) - [Trash Message](#Gmailusersmessagestrash) - [Untrash Message](#Gmailusersmessagesuntrash) - [Add Account Delegate](#Gmailuserssettingsdelegatescreate) - [Remove Account Delegate](#Gmailuserssettingsdelegatesdelete) - [Get Account Delegate](#Gmailuserssettingsdelegatesget) - [List Account Delegates](#Gmailuserssettingsdelegateslist) - [Create Message Filter](#Gmailuserssettingsfilterscreate) - [Delete Message Filter](#Gmailuserssettingsfiltersdelete) - [Get Message Filter](#Gmailuserssettingsfiltersget) - [List Message Filters](#Gmailuserssettingsfilterslist) - [Create New Fowarding Address](#GmailuserssettingsforwardingAddressescreate) - [Delete Forwarding Address](#GmailuserssettingsforwardingAddressesdelete) - [Get Forwarding Address](#GmailuserssettingsforwardingAddressesget) - [List Forwarding Addresses](#GmailuserssettingsforwardingAddresseslist) - [Get Settings - Auto Forwarding](#GmailuserssettingsgetAutoForwarding) - [Get Settings - IMAP](#GmailuserssettingsgetImap) - [Get Settings - Language](#GmailuserssettingsgetLanguage) - [Get Settings - POP](#GmailuserssettingsgetPop) - [Get Settings - Vacation](#GmailuserssettingsgetVacation) - [Create SendAs Alias](#GmailuserssettingssendAscreate) - [Delete SendAs Alias](#GmailuserssettingssendAsdelete) - [Get SendAs Alias](#GmailuserssettingssendAsget) - [List SendAs Aliases](#GmailuserssettingssendAslist) - [Patch SendAs Alias](#GmailuserssettingssendAspatch) - [Delete SendAs Alias S/MIME Config](#GmailuserssettingssendAssmimeInfodelete) - [Get SendAs Alias S/MIME Config](#GmailuserssettingssendAssmimeInfoget) - [Create SendAs Alias S/MIME Config](#GmailuserssettingssendAssmimeInfoinsert) - [List SendAs Alias S/MIME Configs](#GmailuserssettingssendAssmimeInfolist) - [Set Default Send As](#GmailuserssettingssendAssmimeInfosetDefault) - [Update SendAs Alias](#GmailuserssettingssendAsupdate) - [Verify SendAs](#GmailuserssettingssendAsverify) - [Update Settings - Auto Forwarding](#GmailuserssettingsupdateAutoForwarding) - [Update Settings - IMAP](#GmailuserssettingsupdateImap) - [Update Settings - Language](#GmailuserssettingsupdateLanguage) - [Update Settings - POP](#GmailuserssettingsupdatePop) - [Update Settings - Vacation](#GmailuserssettingsupdateVacation) - [Stop Push Notifications](#Gmailusersstop) - [Delete Thread](#Gmailusersthreadsdelete) - [Get Thread](#Gmailusersthreadsget) - [List Threads](#Gmailusersthreadslist) - [Modify Thread Labels](#Gmailusersthreadsmodify) - [Trash Thread](#Gmailusersthreadstrash) - [Untrash Thread](#Gmailusersthreadsuntrash) - [Setup Push Notifications](#Gmailuserswatch) - [Unauthorize](#Unauthorize) ## Sources - [On New Email](#OnNewEmailListener) ## Create Draft `` Creates a new draft with the `DRAFT` label. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/drafts endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete Draft `` Immediately and permanently deletes the specified draft. It does not simply trash it. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/drafts/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

id

String

The ID of the draft to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Draft `` Gets the specified draft. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/drafts/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the draft to retrieve.

x

format

Enumeration, one of:

  • MINIMAL

  • FULL

  • RAW

  • METADATA

Format to return the draft in.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Drafts `` Lists the drafts in the user’s mailbox. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/drafts endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Max Results

Number

Maximum number of drafts to return.

Page Token

String

Page token that retrieves a specific page of results in the list.

q

String

Return only draft messages that match the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".

Include Spam Trash

Boolean

Include drafts from SPAM and TRASH in the results.

false

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Send Draft `` Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/drafts/send endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Draft `` Replaces a draft’s content. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/drafts/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the draft to update.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Profile `` Gets the current user’s Gmail profile. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/profile endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List History `` Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`). This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/history endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Max Results

Number

Maximum number of history records to return.

Page Token

String

Page token that retrieves a specific page of results in the list.

Start History Id

String

Required. Returns history records after the specified startHistoryId. The supplied startHistoryId must be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application must perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request.

Label Id

String

Only return messages with a label matching the ID.

History Types

Array of Enumeration, one of:

  • MESSAGE_ADDED

  • MESSAGE_DELETED

  • LABEL_ADDED

  • LABEL_REMOVED

History types to return by the function.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Create Label `` Creates a new label. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/labels endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete Label `` Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/labels/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the label to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Label `` Gets the specified label. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/labels/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the label to retrieve.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Labels `` Lists all of the labels in the user’s mailbox. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/labels endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Patch Label `` Patch the specified label. This operation makes an HTTP PATCH request to the /gmail/v1/users/{userId}/labels/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the label to update.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Label `` Updates the specified label. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/labels/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the label to update.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Message Attachment `` Gets the specified message attachment. Images that are attached to an email using the clip icon are considered attachments, but images that are dragged into the body of an email are considered embedded images and not attachments. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Message Id

String

The ID of the message containing the attachment.

x

ID

String

The ID of the attachment.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Batch Delete Messages `` Deletes many messages by message ID. Provides no guarantee that messages were not already deleted or that those messages even existed at all. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/batchDelete endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Batch Modify Messages `` Modifies the labels on the specified messages. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/batchModify endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete Message `` Immediately and permanently deletes the specified message. This operation cannot be undone. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/messages/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the message to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Message `` Gets the specified message. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/messages/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the message to retrieve. This ID is usually retrieved using messages.list. The ID is also contained in the result when a message is inserted (messages.insert) or imported (messages.import).

x

format

Enumeration, one of:

  • MINIMAL

  • FULL

  • RAW

  • METADATA

The format to return the message in.

Metadata Headers

Array of String

When the format is METADATA, it includes only specified headers.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Import Message `` Imports a message into a user’s mailbox only, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. This function doesn’t trigger forwarding rules or filters set up by the user. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/import endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Internal Date Source

Enumeration, one of:

  • RECEIVED_TIME

  • DATE_HEADER

Source for Gmail’s internal date of the message.

Never Mark Spam

Boolean

Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.

false

Process For Calendar

Boolean

Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.

false

deleted

Boolean

Mark the email as permanently deleted (not TRASH) and visible only in Google Vault to a Vault administrator. Used only for G Suite accounts.

false

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Insert Message `` Directly inserts a message into only this user’s mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Internal Date Source

Enumeration, one of:

  • RECEIVED_TIME

  • DATE_HEADER

Source for Gmail’s internal date of the message.

deleted

Boolean

Mark the email as permanently deleted (not TRASH) and visible only in Google Vault to a Vault administrator. Used only for G Suite accounts.

false

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Messages `` Lists the messages in the user’s mailbox. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/messages endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Label Ids

Array of String

Return only messages with labels that match all of the specified label IDs.

Max Results

Number

Maximum number of messages to return.

Page Token

String

Page token that retrieves a specific page of results in the list.

q

String

Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope.

Include Spam Trash

Boolean

Include messages from SPAM and TRASH in the results.

false

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Modify Message Labels `` Modifies the labels on the specified message. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/{id}/modify endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the message to modify.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Send Message `` Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/send endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Trash Message `` Moves the specified message to the trash. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/{id}/trash endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the message to trash.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Untrash Message `` Removes the specified message from the trash. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/{id}/untrash endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the message to remove from the trash.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Add Account Delegate `` Adds a delegate with its verification status set directly to `accepted`, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. A delegate user must be referred to by their primary email address, and not an email alias. When a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/delegates endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Remove Account Delegate `` Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. A delegate user must be referred to by their primary email address, and not an email alias. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/settings/delegates/{delegateEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Delegate Email

String

The email address of the user to remove as a delegate.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Account Delegate `` Gets the specified delegate. A delegate user must be referred to by their primary email address, and not an email alias. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/delegates/{delegateEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Delegate Email

String

The email address of the user whose delegate relationship is to retrieve.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Account Delegates `` Lists the delegates for the specified account. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/delegates endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Create Message Filter `` Creates a filter. You can create only a maximum of 1,000 filters. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/filters endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete Message Filter `` Deletes a filter. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/settings/filters/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the filter to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Message Filter `` Gets a filter. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/filters/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the filter to fetch.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Message Filters `` Lists the message filters of a Gmail user. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/filters endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Create New Fowarding Address `` Creates a forwarding address. If ownership verification is required, a message is sent to the recipient and the resource’s verification status will be set to `pending`. If not, the resource is created with a verification status set to `accepted`. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/forwardingAddresses endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete Forwarding Address `` Deletes the specified forwarding address and revokes any verification that may have been required. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Forwarding Email

String

The forwarding address to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Forwarding Address `` Gets the specified forwarding address. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Forwarding Email

String

The forwarding address to retrieve.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Forwarding Addresses `` Lists the forwarding addresses for the specified account. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/forwardingAddresses endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Settings - Auto Forwarding `` Gets the auto-forwarding setting for the specified account. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/autoForwarding endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Settings - IMAP `` Gets the IMAP settings. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/imap endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Settings - Language `` Gets the language settings. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/language endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Settings - POP `` Gets POP settings. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/pop endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Settings - Vacation `` Gets the vacation responder settings. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/vacation endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Create SendAs Alias `` Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail attempts to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message is sent to the email address and the resource’s verification status will be set to `pending`. If not, the resource is created with a verification status set to `accepted`. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/sendAs endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete SendAs Alias `` Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The send-as alias to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get SendAs Alias `` Gets the specified send-as alias. Fails and returns an HTTP 404 error if the specified address is not a member of the collection. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The send-as alias to retrieve.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List SendAs Aliases `` Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/sendAs endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Patch SendAs Alias `` Patch the specified send-as alias. This operation makes an HTTP PATCH request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The send-as alias to update.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete SendAs Alias S/MIME Config `` Deletes the specified S/MIME config for the specified send-as alias. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The email address that appears in the "From:" header for mail sent using this alias.

x

ID

String

The immutable ID for the SmimeInfo.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get SendAs Alias S/MIME Config `` Gets the specified S/MIME config for the specified send-as alias. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The email address that appears in the "From:" header for mail sent using this alias.

x

ID

String

The immutable ID for the SmimeInfo.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Create SendAs Alias S/MIME Config `` Insert and upload the given S/MIME config for the specified send-as alias. The pkcs12 format is required for the key. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The email address that appears in the "From:" header for mail sent using this alias.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List SendAs Alias S/MIME Configs `` Lists S/MIME configs for the specified send-as alias. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The email address that appears in the "From:" header for mail sent using this alias.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Set Default Send As `` Sets the default S/MIME config for the specified send-as alias. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The email address that appears in the "From:" header for mail sent using this alias.

x

ID

String

The immutable ID for the SmimeInfo.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update SendAs Alias `` Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can be updated only by service account clients that have been delegated domain-wide authority. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The send-as alias to update.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Verify SendAs `` Sends a verification email to the specified send-as alias address. The verification status must be `pending`. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The send-as alias to verify.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Settings - Auto Forwarding `` Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/settings/autoForwarding endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Settings - IMAP `` Updates IMAP settings. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/settings/imap endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Settings - Language `` Updates language settings. If successful, the return object contains the `displayLanguage` that was saved for the user, which may differ from the value passed into the request. This is because the requested `displayLanguage` may not be directly supported by Gmail but have a close variant that is, and this variant can be chosen and saved instead. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/settings/language endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Settings - POP `` Updates POP settings. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/settings/pop endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Settings - Vacation `` Updates vacation responder settings. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/settings/vacation endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Stop Push Notifications `` Stop receiving push notifications for the given user mailbox. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/stop endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete Thread `` Immediately and permanently deletes the specified thread. This operation cannot be undone. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/threads/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

ID of the Thread to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Thread `` Gets the specified thread. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/threads/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the thread to retrieve.

x

format

Enumeration, one of:

  • FULL

  • METADATA

  • MINIMAL

The format to return the messages in.

Metadata Headers

Array of String

When given and format is METADATA, only include headers specified.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Threads `` Lists the threads in the user’s mailbox. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/threads endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Label Ids

Array of String

Only return threads with labels that match all of the specified label IDs.

Max Results

Number

Maximum number of threads to return.

Page Token

String

Page token that retrieves a specific page of results in the list.

q

String

Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope.

Include Spam Trash

Boolean

Include threads from SPAM and TRASH in the results.

false

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Modify Thread Labels `` Modifies the labels applied to the thread. This applies to all messages in the thread. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/threads/{id}/modify endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the thread to modify.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Trash Thread `` Moves the specified thread to the trash. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/threads/{id}/trash endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the thread to Trash.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Untrash Thread `` Removes the specified thread from the trash. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/threads/{id}/untrash endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the thread to remove from Trash.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Setup Push Notifications `` Set up or update a push notification watch on the given user mailbox. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/watch endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Unauthorize `` Deletes all of the access token information of a given resource owner ID so that it is impossible to execute any operation for that user without doing the authorization dance again. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Resource Owner Id

String

ID of the resource owner which access should be invalidated.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

### For Configurations - [Default Configuration](#Config) ## On New Email `` Enters the flow when a new email is received. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

After

String

Date that emails are polled. The format of the date is yyyy/mm/dd.

Search Query

String

Search phrase, such as in:label or from:foo@bar.com.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ## Types ### Default Header Headers automatically added to every outbound request.
FieldTypeDescriptionDefault ValueRequired

Key

String

Key for this type.

x

Value

String

Value for this type.

x

### Default Query Param
FieldTypeDescriptionDefault ValueRequired

Key

String

Key for this type.

x

Value

String

Value for this type.

x

### Proxy Configures the settings used to connect through a proxy.
FieldTypeDescriptionDefault ValueRequired

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

Non Proxy Hosts

String

### TLS Configures TLS to provide secure communications for the Mule app.
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Revocation Check

Configures how to validate certificates.

### Truststore Configures the truststore for TLS.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Settig this to true can make connections vulnerable to attacks.

### Keystore Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.

Type

String

Type of store used.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

### Standard Revocation Check Configures standard revocation checks for TLS certificates.
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

Verify only the last element in the certificate chain.

  • false

Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

Check the Certification Revocation List (CRL) for certificate validity.

  • false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

Use the method that wasn’t specified in the <b>Prefer Crls</b> field (the secondary method) to check certificate validity.

  • false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

Avoid verification failure.

  • false

Allow the verification to fail.

### Custom OCSP Responder Configures a custom OCSP responder for certification revocation checks.
FieldTypeDescriptionDefault ValueRequired

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certicate for the OCSP response. If specified, the alias must be in the truststore.

### CRL File Specifies the location of the certification revocation list (CRL) file.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the CRL file.

### Reconnection Configures a reconnection strategy for an operation.
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

Allow the deployment to fail.

  • false

Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

### Reconnect Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

### Reconnect Forever Configures a forever reconnection strategy by which the connector operation source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often the Mule app attempts to reconnect to the remote service or API, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

### Expiration Policy Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

### HTTP Response Attributes
FieldTypeDescriptionDefault ValueRequired

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

### Repeatable In Memory Stream Configures the in-memory streaming strategy by which the request fails if the data exceeds the buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

Initial amount of memory to allocate to the memory stream. If the stream data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

### Repeatable File Store Stream Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

## See Also - [Gmail Connector Overview](https://docs.mulesoft.com/gmail-connector/1.0/) - [Salesforce Help](https://help.salesforce.com) --- product: Gmail Connector version: 1.1 is-latest-version: true --- # Gmail Connector 1.1 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Gmail (Gmail Connector) enables the management of your Gmail account, including sending and receiving emails and reacting to received emails. For information about compatibility and fixed issues, see the Gmail Connector Release Notes. ## Before You Begin To use this connector, you must be familiar with: - The Gmail Connector’s API - Anypoint Connectors - Mule runtime engine (Mule) - Elements and global elements in a Mule flow - How to create a Mule app using Anypoint Studio Before creating an app, you must have: - Credentials to access the Gmail target resource - Anypoint Platform - Anypoint Studio version 7.0 or later ## Common Use Cases For the Connector Some possible uses for this connector include: - Sending an email to thank customers for a new purchase. - Organizing all emails related to an event. - Receiving attachments via email to verify an ID. ## Connection Types Gmail connections use the Oauth2c authentication type, which uses access tokens provided by the authorization server to access protected data. For information about configuring authentication types, see [Using Anypoint Studio to Configure Gmail Connector](https://docs.mulesoft.com/gmail-connector/latest/gmail-connector-studio). ## Next Step After you complete the prerequisites, you are ready to create an app and configure the connector using [Anypoint Studio](https://docs.mulesoft.com/gmail-connector/latest/gmail-connector-studio). ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Use Exchange to Discover Connectors, Templates, and Examples](https://docs.mulesoft.com/connectors/introduction/intro-use-exchange) - [Gmail Connector Reference](https://docs.mulesoft.com/gmail-connector/latest/gmail-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Gmail Connector version: 1.1 is-latest-version: true --- # Gmail Connector 1.1 - XML and Maven Support > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Although you can manually code a Mule app in XML, it is more efficient to use Anypoint Studio: - If you manually code a Mule runtime engine (Mule) app in XML either from the Anypoint Studio XML editor or from a text editor, you can access the connector from your app by adding reference statements to both your XML Mule flow and the Apache Maven `pom.xml` file. - If you add the connector in Studio, Studio automatically populates the XML code with the connector’s namespace and schema location and it also adds a dependency to the `pom.xml` file. ## Add a Namespace for the Connector Paste the following code inside the `mule` tag of the header of your configuration XML: ```xml http://www.mulesoft.org/schema/mule/gmail http://www.mulesoft.org/schema/mule/gmail/current/mule-gmail.xsd ``` This example shows how the namespace statements are placed in the XML: ```xml ``` ## Add a POM File Dependency The Apache Maven `pom.xml` file generated by Anypoint Studio contains dependencies for a Mule app. When you code a Mule app manually, include this XML snippet in your `pom.xml` file to enable access to this connector: ```xml com.mulesoft.connectors mule4-gmail-connector x.x.x mule-plugin ``` Replace `` with the version that corresponds to the connector you are using. To obtain the most up-to-date `pom.xml` file information: 1. Go to [Anypoint Exchange](https://www.mulesoft.com/exchange/). 2. In Exchange, click **Login** and supply your Anypoint Platform username and password. 3. In Exchange, search for `Gmail`. 4. Select the connector. 5. Click **Dependency Snippets** near the upper right of the screen. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Salesforce Help](https://help.salesforce.com) --- product: Gmail Connector version: 1.1 is-latest-version: true --- # Gmail Connector 1.1 Reference > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Connector for Gmail (Gmail Connector) enables the management of your Gmail account, including sending and receiving emails and reacting to received emails. ## Default Configuration ### Parameters
NameTypeDescriptionDefault ValueRequired

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection types for this configuration.

x

Response Timeout

Number

How long Mule waits for a response to complete before the response times out.

1

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

MINUTES

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

How the connector streams request content to the remote service:

* AUTO (default)

Connector automatically uses the best streaming strategy based on the request content.

* ALWAYS

Connector always streams the request content.

* NEVER

Connector does not stream the request content.

AUTO

Name

String

ID used to reference this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

### Connection Types #### Oauth2c Connection Provider Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). ##### Parameters
NameTypeDescriptionDefault ValueRequired

Default Headers

Query Parameters

Connection Timeout

Number

How long the connector waits before timing out when initially establishing a connection to the remote service.

30

Connection Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Timeout field.

SECONDS

Use Persistent Connections

Boolean

Indicates whether to use persistent connections:

* true

Mule uses persistent connections.

* false

Mule closes the connection after the first request completes.

true

Max Connections

Number

Maximum number of connections to open to the backend. HTTP requests are sent in parallel over multiple connections. Setting this value too high can impact latency and consume additional resources without increasing throughput.

-1

Connection Idle Timeout

Number

When persistent connections are enabled, how long a connection can remain idle before Mule closes it.

30

Connection Idle Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Connection Idle Timeout field.

SECONDS

Proxy Config

Configures a proxy for outbound connections.

Stream Response

Boolean

If this value is true, Mule streams received responses.

false

Response Buffer Size

Number

Size of the buffer that stores the HTTP response, in bytes.

-1

Access Type

String

Access type.

offline

Prompt

String

Asks for user consent even if the user is already logged in.

consent

Base Uri

String

Parameter base URI. Each instance or tenant gets its own.

https://www.googleapis.com

Protocol

Enumeration, one of:

  • HTTP

  • HTTPS

Protocol to use for communication. Valid values are HTTP and HTTPS.

HTTP

TLS Configuration

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Configures a reconnection strategy to use when a connector operation fails to connect to an external server.

Consumer Key

String

OAuth consumer key, as registered with the service provider.

x

Consumer Secret

String

OAuth consumer secret, as registered with the service provider.

x

Authorization Url

String

URL of the service provider’s authorization endpoint.

https://accounts.google.com/o/oauth2/auth

Access Token Url

String

URL of the service provider’s access token endpoint.

https://accounts.google.com/o/oauth2/token

Scopes

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation. Valid values are:

  • <Scope 1>

  • <Scope 2>

  • https://mail.google.com/

  • https://www.googleapis.com/auth/gmail.addons.current.action.compose

  • https://www.googleapis.com/auth/gmail.addons.current.message.action

  • https://www.googleapis.com/auth/gmail.addons.current.message.metadata

  • https://www.googleapis.com/auth/gmail.addons.current.message.readonly

  • https://www.googleapis.com/auth/gmail.compose

  • https://www.googleapis.com/auth/gmail.insert

  • https://www.googleapis.com/auth/gmail.labels

  • https://www.googleapis.com/auth/gmail.metadata

  • https://www.googleapis.com/auth/gmail.modify

  • https://www.googleapis.com/auth/gmail.readonly

  • https://www.googleapis.com/auth/gmail.send

Resource Owner Id

String

Resource owner ID to use with the authorization code grant type.

Before

String

Name of the flow to execute immediately before starting the OAuth dance.

After

String

Name of the flow to execute immediately after receiving an accessToken.

Listener Config

String

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

## Operations - [Create Draft](#CreateDraft) - [Get Attachments](#GetAttachments) - [Delete Draft](#Gmailusersdraftsdelete) - [Get Draft](#Gmailusersdraftsget) - [List Drafts](#Gmailusersdraftslist) - [Send Draft](#Gmailusersdraftssend) - [Update Draft](#Gmailusersdraftsupdate) - [Get Profile](#GmailusersgetProfile) - [List History](#Gmailusershistorylist) - [Create Label](#Gmailuserslabelscreate) - [Delete Label](#Gmailuserslabelsdelete) - [Get Label](#Gmailuserslabelsget) - [List Labels](#Gmailuserslabelslist) - [Patch Label](#Gmailuserslabelspatch) - [Update Label](#Gmailuserslabelsupdate) - [Get Message Attachment](#Gmailusersmessagesattachmentsget) - [Batch Delete Messages](#GmailusersmessagesbatchDelete) - [Batch Modify Messages](#GmailusersmessagesbatchModify) - [Delete Message](#Gmailusersmessagesdelete) - [Get Message](#Gmailusersmessagesget) - [Import Message](#Gmailusersmessagesimport) - [Insert Message](#Gmailusersmessagesinsert) - [List Messages](#Gmailusersmessageslist) - [Modify Message Labels](#Gmailusersmessagesmodify) - [Send Message](#Gmailusersmessagessend) - [Trash Message](#Gmailusersmessagestrash) - [Untrash Message](#Gmailusersmessagesuntrash) - [Add Account Delegate](#Gmailuserssettingsdelegatescreate) - [Remove Account Delegate](#Gmailuserssettingsdelegatesdelete) - [Get Account Delegate](#Gmailuserssettingsdelegatesget) - [List Account Delegates](#Gmailuserssettingsdelegateslist) - [Create Message Filter](#Gmailuserssettingsfilterscreate) - [Delete Message Filter](#Gmailuserssettingsfiltersdelete) - [Get Message Filter](#Gmailuserssettingsfiltersget) - [List Message Filters](#Gmailuserssettingsfilterslist) - [Create New Fowarding Address](#GmailuserssettingsforwardingAddressescreate) - [Delete Forwarding Address](#GmailuserssettingsforwardingAddressesdelete) - [Get Forwarding Address](#GmailuserssettingsforwardingAddressesget) - [List Forwarding Addresses](#GmailuserssettingsforwardingAddresseslist) - [Get Settings - Auto Forwarding](#GmailuserssettingsgetAutoForwarding) - [Get Settings - IMAP](#GmailuserssettingsgetImap) - [Get Settings - Language](#GmailuserssettingsgetLanguage) - [Get Settings - POP](#GmailuserssettingsgetPop) - [Get Settings - Vacation](#GmailuserssettingsgetVacation) - [Create SendAs Alias](#GmailuserssettingssendAscreate) - [Delete SendAs Alias](#GmailuserssettingssendAsdelete) - [Get SendAs Alias](#GmailuserssettingssendAsget) - [List SendAs Aliases](#GmailuserssettingssendAslist) - [Patch SendAs Alias](#GmailuserssettingssendAspatch) - [Delete SendAs Alias S/MIME Config](#GmailuserssettingssendAssmimeInfodelete) - [Get SendAs Alias S/MIME Config](#GmailuserssettingssendAssmimeInfoget) - [Create SendAs Alias S/MIME Config](#GmailuserssettingssendAssmimeInfoinsert) - [List SendAs Alias S/MIME Configs](#GmailuserssettingssendAssmimeInfolist) - [Set Default Send As](#GmailuserssettingssendAssmimeInfosetDefault) - [Update SendAs Alias](#GmailuserssettingssendAsupdate) - [Verify SendAs](#GmailuserssettingssendAsverify) - [Update Settings - Auto Forwarding](#GmailuserssettingsupdateAutoForwarding) - [Update Settings - IMAP](#GmailuserssettingsupdateImap) - [Update Settings - Language](#GmailuserssettingsupdateLanguage) - [Update Settings - POP](#GmailuserssettingsupdatePop) - [Update Settings - Vacation](#GmailuserssettingsupdateVacation) - [Stop Push Notifications](#Gmailusersstop) - [Delete Thread](#Gmailusersthreadsdelete) - [Get Thread](#Gmailusersthreadsget) - [List Threads](#Gmailusersthreadslist) - [Modify Thread Labels](#Gmailusersthreadsmodify) - [Trash Thread](#Gmailusersthreadstrash) - [Untrash Thread](#Gmailusersthreadsuntrash) - [Setup Push Notifications](#Gmailuserswatch) - [Unauthorize](#Unauthorize) ## Sources - [On New Email](#OnNewEmailListener) ## Create Draft `` Creates a new draft with the `DRAFT` label. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/drafts endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Attachments `` Gets the specified message attachment content. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/messages/{messageId}/attachments/{attId} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Message Id

String

The ID of the message containing the attachment.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Array of Get Email Attachment Response

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete Draft `` Immediately and permanently deletes the specified draft. It does not simply trash it. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/drafts/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

id

String

The ID of the draft to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Draft `` Gets the specified draft. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/drafts/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the draft to retrieve.

x

format

Enumeration, one of:

  • MINIMAL

  • FULL

  • RAW

  • METADATA

Format to return the draft in.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Drafts `` Lists the drafts in the user’s mailbox. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/drafts endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Max Results

Number

Maximum number of drafts to return.

Page Token

String

Page token that retrieves a specific page of results in the list.

q

String

Return only draft messages that match the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread".

Include Spam Trash

Boolean

Include drafts from SPAM and TRASH in the results.

false

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Send Draft `` Sends the specified, existing draft to the recipients in the `To`, `Cc`, and `Bcc` headers. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/drafts/send endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Draft `` Replaces a draft’s content. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/drafts/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the draft to update.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Profile `` Gets the current user’s Gmail profile. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/profile endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List History `` Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing `historyId`). This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/history endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Max Results

Number

Maximum number of history records to return.

Page Token

String

Page token that retrieves a specific page of results in the list.

Start History Id

String

Required. Returns history records after the specified startHistoryId. The supplied startHistoryId must be obtained from the historyId of a message, thread, or previous list response. History IDs increase chronologically but are not contiguous with random gaps in between valid IDs. Supplying an invalid or out of date startHistoryId typically returns an HTTP 404 error code. A historyId is typically valid for at least a week, but in some rare circumstances may be valid for only a few hours. If you receive an HTTP 404 error response, your application must perform a full sync. If you receive no nextPageToken in the response, there are no updates to retrieve and you can store the returned historyId for a future request.

Label Id

String

Only return messages with a label matching the ID.

History Types

Array of Enumeration, one of:

  • MESSAGE_ADDED

  • MESSAGE_DELETED

  • LABEL_ADDED

  • LABEL_REMOVED

History types to return by the function.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Create Label `` Creates a new label. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/labels endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete Label `` Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/labels/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the label to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Label `` Gets the specified label. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/labels/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the label to retrieve.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Labels `` Lists all of the labels in the user’s mailbox. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/labels endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Patch Label `` Patch the specified label. This operation makes an HTTP PATCH request to the /gmail/v1/users/{userId}/labels/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the label to update.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Label `` Updates the specified label. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/labels/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the label to update.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Message Attachment `` Gets the specified message attachment. Images that are attached to an email using the clip icon are considered attachments, but images that are dragged into the body of an email are considered embedded images and not attachments. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/messages/{messageId}/attachments/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Message Id

String

The ID of the message containing the attachment.

x

ID

String

The ID of the attachment.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Batch Delete Messages `` Deletes many messages by message ID. Provides no guarantee that messages were not already deleted or that those messages even existed at all. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/batchDelete endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Batch Modify Messages `` Modifies the labels on the specified messages. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/batchModify endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete Message `` Immediately and permanently deletes the specified message. This operation cannot be undone. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/messages/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the message to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Message `` Gets the specified message. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/messages/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the message to retrieve. This ID is usually retrieved using messages.list. The ID is also contained in the result when a message is inserted (messages.insert) or imported (messages.import).

x

format

Enumeration, one of:

  • MINIMAL

  • FULL

  • RAW

  • METADATA

The format to return the message in.

Metadata Headers

Array of String

When the format is METADATA, it includes only specified headers.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Import Message `` Imports a message into a user’s mailbox only, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. This function doesn’t trigger forwarding rules or filters set up by the user. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/import endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Internal Date Source

Enumeration, one of:

  • RECEIVED_TIME

  • DATE_HEADER

Source for Gmail’s internal date of the message.

Never Mark Spam

Boolean

Ignore the Gmail spam classifier decision and never mark this email as SPAM in the mailbox.

false

Process For Calendar

Boolean

Process calendar invites in the email and add any extracted meetings to the Google Calendar for this user.

false

deleted

Boolean

Mark the email as permanently deleted (not TRASH) and visible only in Google Vault to a Vault administrator. Used only for G Suite accounts.

false

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Insert Message `` Directly inserts a message into only this user’s mailbox similar to `IMAP APPEND`, bypassing most scanning and classification. Does not send a message. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Internal Date Source

Enumeration, one of:

  • RECEIVED_TIME

  • DATE_HEADER

Source for Gmail’s internal date of the message.

deleted

Boolean

Mark the email as permanently deleted (not TRASH) and visible only in Google Vault to a Vault administrator. Used only for G Suite accounts.

false

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Messages `` Lists the messages in the user’s mailbox. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/messages endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Label Ids

Array of String

Return only messages with labels that match all of the specified label IDs.

Max Results

Number

Maximum number of messages to return.

Page Token

String

Page token that retrieves a specific page of results in the list.

q

String

Only return messages matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope.

Include Spam Trash

Boolean

Include messages from SPAM and TRASH in the results.

false

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Modify Message Labels `` Modifies the labels on the specified message. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/{id}/modify endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the message to modify.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Send Message `` Sends the specified message to the recipients in the `To`, `Cc`, and `Bcc` headers. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/send endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Trash Message `` Moves the specified message to the trash. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/{id}/trash endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the message to trash.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Untrash Message `` Removes the specified message from the trash. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/messages/{id}/untrash endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the message to remove from the trash.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Add Account Delegate `` Adds a delegate with its verification status set directly to `accepted`, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. Gmail imposes limitations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. A delegate user must be referred to by their primary email address, and not an email alias. When a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/delegates endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Remove Account Delegate `` Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. A delegate user must be referred to by their primary email address, and not an email alias. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/settings/delegates/{delegateEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Delegate Email

String

The email address of the user to remove as a delegate.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Account Delegate `` Gets the specified delegate. A delegate user must be referred to by their primary email address, and not an email alias. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/delegates/{delegateEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Delegate Email

String

The email address of the user whose delegate relationship is to retrieve.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Account Delegates `` Lists the delegates for the specified account. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/delegates endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Create Message Filter `` Creates a filter. You can create only a maximum of 1,000 filters. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/filters endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete Message Filter `` Deletes a filter. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/settings/filters/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the filter to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Message Filter `` Gets a filter. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/filters/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the filter to fetch.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Message Filters `` Lists the message filters of a Gmail user. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/filters endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Create New Fowarding Address `` Creates a forwarding address. If ownership verification is required, a message is sent to the recipient and the resource’s verification status will be set to `pending`. If not, the resource is created with a verification status set to `accepted`. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/forwardingAddresses endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete Forwarding Address `` Deletes the specified forwarding address and revokes any verification that may have been required. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Forwarding Email

String

The forwarding address to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Forwarding Address `` Gets the specified forwarding address. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/forwardingAddresses/{forwardingEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Forwarding Email

String

The forwarding address to retrieve.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Forwarding Addresses `` Lists the forwarding addresses for the specified account. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/forwardingAddresses endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Settings - Auto Forwarding `` Gets the auto-forwarding setting for the specified account. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/autoForwarding endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Settings - IMAP `` Gets the IMAP settings. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/imap endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Settings - Language `` Gets the language settings. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/language endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Settings - POP `` Gets POP settings. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/pop endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Settings - Vacation `` Gets the vacation responder settings. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/vacation endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Create SendAs Alias `` Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail attempts to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message is sent to the email address and the resource’s verification status will be set to `pending`. If not, the resource is created with a verification status set to `accepted`. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/sendAs endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete SendAs Alias `` Deletes the specified send-as alias. Revokes any verification that may have been required for using it. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The send-as alias to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get SendAs Alias `` Gets the specified send-as alias. Fails and returns an HTTP 404 error if the specified address is not a member of the collection. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The send-as alias to retrieve.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List SendAs Aliases `` Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/sendAs endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Patch SendAs Alias `` Patch the specified send-as alias. This operation makes an HTTP PATCH request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The send-as alias to update.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete SendAs Alias S/MIME Config `` Deletes the specified S/MIME config for the specified send-as alias. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The email address that appears in the "From:" header for mail sent using this alias.

x

ID

String

The immutable ID for the SmimeInfo.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get SendAs Alias S/MIME Config `` Gets the specified S/MIME config for the specified send-as alias. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The email address that appears in the "From:" header for mail sent using this alias.

x

ID

String

The immutable ID for the SmimeInfo.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Create SendAs Alias S/MIME Config `` Insert and upload the given S/MIME config for the specified send-as alias. The pkcs12 format is required for the key. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The email address that appears in the "From:" header for mail sent using this alias.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List SendAs Alias S/MIME Configs `` Lists S/MIME configs for the specified send-as alias. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The email address that appears in the "From:" header for mail sent using this alias.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Set Default Send As `` Sets the default S/MIME config for the specified send-as alias. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/smimeInfo/{id}/setDefault endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The email address that appears in the "From:" header for mail sent using this alias.

x

ID

String

The immutable ID for the SmimeInfo.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update SendAs Alias `` Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. Addresses other than the primary address for the account can be updated only by service account clients that have been delegated domain-wide authority. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The send-as alias to update.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Verify SendAs `` Sends a verification email to the specified send-as alias address. The verification status must be `pending`. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/settings/sendAs/{sendAsEmail}/verify endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Send As Email

String

The send-as alias to verify.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Settings - Auto Forwarding `` Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. This method is available only to service account clients that have been delegated domain-wide authority. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/settings/autoForwarding endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Settings - IMAP `` Updates IMAP settings. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/settings/imap endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Settings - Language `` Updates language settings. If successful, the return object contains the `displayLanguage` that was saved for the user, which may differ from the value passed into the request. This is because the requested `displayLanguage` may not be directly supported by Gmail but have a close variant that is, and this variant can be chosen and saved instead. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/settings/language endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Settings - POP `` Updates POP settings. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/settings/pop endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Update Settings - Vacation `` Updates vacation responder settings. This operation makes an HTTP PUT request to the /gmail/v1/users/{userId}/settings/vacation endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Stop Push Notifications `` Stop receiving push notifications for the given user mailbox. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/stop endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Delete Thread `` Immediately and permanently deletes the specified thread. This operation cannot be undone. This operation makes an HTTP DELETE request to the /gmail/v1/users/{userId}/threads/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

ID of the Thread to delete.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

String

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Get Thread `` Gets the specified thread. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/threads/{id} endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the thread to retrieve.

x

format

Enumeration, one of:

  • FULL

  • METADATA

  • MINIMAL

The format to return the messages in.

Metadata Headers

Array of String

When given and format is METADATA, only include headers specified.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## List Threads `` Lists the threads in the user’s mailbox. This operation makes an HTTP GET request to the /gmail/v1/users/{userId}/threads endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Label Ids

Array of String

Only return threads with labels that match all of the specified label IDs.

Max Results

Number

Maximum number of threads to return.

Page Token

String

Page token that retrieves a specific page of results in the list.

q

String

Only return threads matching the specified query. Supports the same query format as the Gmail search box. For example, "from:someuser@example.com rfc822msgid: is:unread". Parameter cannot be used when accessing the api using the gmail.metadata scope.

Include Spam Trash

Boolean

Include threads from SPAM and TRASH in the results.

false

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Modify Thread Labels `` Modifies the labels applied to the thread. This applies to all messages in the thread. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/threads/{id}/modify endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the thread to modify.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Trash Thread `` Moves the specified thread to the trash. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/threads/{id}/trash endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the thread to Trash.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Untrash Thread `` Removes the specified thread from the trash. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/threads/{id}/untrash endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

ID

String

The ID of the thread to remove from Trash.

x

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

#[null]

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Setup Push Notifications `` Set up or update a push notification watch on the given user mailbox. This operation makes an HTTP POST request to the /gmail/v1/users/{userId}/watch endpoint. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

User Id

String

User’s email address. The special value me can be used to indicate the authenticated user.

x

Body

Any

The content to use.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Custom Query Parameters

Object

Custom query parameters to include in the request. The specified query parameters are merged with the default query parameters that are specified in the configuration.

Custom Headers

Object

Custom headers to include in the request. The specified custom headers are merged with the default headers that are specified in the configuration.

Response Timeout

Number

Response timeout for the request.

Response Timeout Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Response Timeout field.

Streaming Type

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Defines whether to send the request using streaming. If the value is set to AUTO, the best strategy is automatically determined based on the content of the request.

Target Variable

String

Name of the variable that stores the operation’s output.

Target Value

String

Expression that evaluates the operation’s output. The expression outcome is stored in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ### Throws - GMAIL:BAD\_REQUEST - GMAIL:CLIENT\_ERROR - GMAIL:CONNECTIVITY - GMAIL:INTERNAL\_SERVER\_ERROR - GMAIL:NOT\_ACCEPTABLE - GMAIL:NOT\_FOUND - GMAIL:RETRY\_EXHAUSTED - GMAIL:SERVER\_ERROR - GMAIL:SERVICE\_UNAVAILABLE - GMAIL:TIMEOUT - GMAIL:TOO\_MANY\_REQUESTS - GMAIL:UNAUTHORIZED - GMAIL:UNSUPPORTED\_MEDIA\_TYPE ## Unauthorize `` Deletes all of the access token information of a given resource owner ID so that it is impossible to execute any operation for that user without doing the authorization dance again. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

Resource Owner Id

String

ID of the resource owner which access should be invalidated.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

### For Configurations - [Default Configuration](#Config) ## On New Email `` Enters the flow when a new email is received. ### Parameters
NameTypeDescriptionDefault ValueRequired

Configuration

String

Name of the configuration to use.

x

After

String

Date that emails are polled. The format of the date is yyyy/mm/dd.

Search Query

String

Search phrase, such as in:label or from:foo@bar.com.

Config Ref

ConfigurationProvider

Name of the configuration used to execute this component.

x

Scheduling Strategy

scheduling-strategy

Configures the scheduler that triggers the polling.

x

Streaming Strategy

Configures how Mule processes streams. Repeatable streams are the default behavior.

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Reconnection Strategy

Retry strategy in case of connectivity errors.

### Output

Type

Any

Attributes Type

### For Configurations - [Default Configuration](#Config) ## Types ### Default Header Headers automatically added to every outbound request.
FieldTypeDescriptionDefault ValueRequired

Key

String

Key for this type.

x

Value

String

Value for this type.

x

### Default Query Param
FieldTypeDescriptionDefault ValueRequired

Key

String

Key for this type.

x

Value

String

Value for this type.

x

### Proxy Configures the settings used to connect through a proxy.
FieldTypeDescriptionDefault ValueRequired

Host

String

Hostname or IP address of the proxy server.

x

Port

Number

Port of the proxy server.

x

Username

String

Username to authenticate against the proxy server.

Password

String

Password to authenticate against the proxy server.

Non Proxy Hosts

String

### TLS Configures TLS to provide secure communications for the Mule app.
FieldTypeDescriptionDefault ValueRequired

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Configures the TLS truststore.

Key Store

Configures the TLS keystore.

Revocation Check

Configures how to validate certificates.

### Truststore Configures the truststore for TLS.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system, if possible.

Password

String

Password used to protect the truststore.

Type

String

Type of truststore.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Settig this to true can make connections vulnerable to attacks.

### Keystore Configures the keystore for the TLS protocol. The keystore you generate contains a private key and a public certificate.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system, if possible.

Type

String

Type of store used.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

### Standard Revocation Check Configures standard revocation checks for TLS certificates.
FieldTypeDescriptionDefault ValueRequired

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

Verify only the last element in the certificate chain.

  • false

Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

Check the Certification Revocation List (CRL) for certificate validity.

  • false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

Use the method that wasn’t specified in the <b>Prefer Crls</b> field (the secondary method) to check certificate validity.

  • false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

Avoid verification failure.

  • false

Allow the verification to fail.

### Custom OCSP Responder Configures a custom OCSP responder for certification revocation checks.
FieldTypeDescriptionDefault ValueRequired

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certicate for the OCSP response. If specified, the alias must be in the truststore.

### CRL File Specifies the location of the certification revocation list (CRL) file.
FieldTypeDescriptionDefault ValueRequired

Path

String

Path to the CRL file.

### Reconnection Configures a reconnection strategy for an operation.
FieldTypeDescriptionDefault ValueRequired

Fails Deployment

Boolean

What to do if, when an app is deployed, a connectivity test does not pass after exhausting the associated reconnection strategy:

  • true

Allow the deployment to fail.

  • false

Ignore the results of the connectivity test.

Reconnection Strategy

Reconnection strategy to use.

### Reconnect Configures a standard reconnection strategy, which specifies how often to reconnect and how many reconnection attempts the connector source or operation can make.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

### Reconnect Forever Configures a forever reconnection strategy by which the connector operation source or operation attempts to reconnect at a specified frequency for as long as the Mule app runs.
FieldTypeDescriptionDefault ValueRequired

Frequency

Number

How often the Mule app attempts to reconnect to the remote service or API, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy will run in a separate, non-blocking thread.

### Expiration Policy Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.
FieldTypeDescriptionDefault ValueRequired

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

### HTTP Response Attributes
FieldTypeDescriptionDefault ValueRequired

Status Code

Number

x

Headers

Object

x

Reason Phrase

String

x

### Repeatable In Memory Stream Configures the in-memory streaming strategy by which the request fails if the data exceeds the buffer size. Always run performance tests to find the optimal buffer size for your specific use case.
FieldTypeDescriptionDefault ValueRequired

Initial Buffer Size

Number

Initial amount of memory to allocate to the memory stream. If the stream data exceeds this value, the buffer expands by Buffer Size Increment, with an upper limit of Max In Memory Size value.

Buffer Size Increment

Number

Amount by which the buffer size expands if it exceeds its initial size. Setting a value of 0 or lower specifies that the buffer can’t expand.

Max Buffer Size

Number

Maximum size of the buffer. If the buffer size exceeds this value, Mule raises a STREAM_MAXIMUM_SIZE_EXCEEDED error. A value of less than or equal to 0 means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the Initial Buffer Size, Buffer Size Increment, and Buffer Unit fields.

### Repeatable File Store Stream Configures the repeatable file-store streaming strategy by which Mule keeps a portion of the stream content in memory. If the stream content is larger than the configured buffer size, Mule backs up the buffer’s content to disk and then clears the memory.
FieldTypeDescriptionDefault ValueRequired

In Memory Size

Number

Maximum amount of memory that the stream can use for data. If the amount of memory exceeds this value, Mule buffers the content to disk. To optimize performance:

  • Configure a larger buffer size to avoid the number of times Mule needs to write the buffer on disk. This increases performance, but it also limits the number of concurrent requests your application can process, because it requires additional memory.

  • Configure a smaller buffer size to decrease memory load at the expense of response time.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

Unit for the In Memory Size field.

### Redelivery Policy Configures the redelivery policy for executing requests that generate errors. You can add a redelivery policy to any source in a flow.
FieldTypeDescriptionDefault ValueRequired

Max Redelivery Count

Number

Maximum number of times that a redelivered request can be processed unsuccessfully before returning a REDELIVERY_EXHAUSTED error.

Message Digest Algorithm

String

Secure hashing algorithm to use if the Use Secure Hash field is true. If the payload of the message is a Java object, Mule ignores this value and returns the value that the payload’s hashCode() returned.

Message Identifier

Defines which strategy is used to identify the messages.

Object Store

ObjectStore

Configures the object store that stores the redelivery counter for each message.

### Redelivery Policy Message Identifier Configures how to identify a redelivered message and how to find out when the message was redelivered.
FieldTypeDescriptionDefault ValueRequired

Use Secure Hash

Boolean

If true, Mule uses a secure hash algorithm to identify a redelivered message.

Id Expression

String

One or more expressions that determine when a message was redelivered. You can set this property only if the Use Secure Hash field is false.

### Get Email Attachment Response Content and metadata of an email attachment.
FieldTypeDescriptionDefault ValueRequired

Content

Binary

Binary content of the attachment.

Filetype

String

MIME type of the attachment.

Id

String

ID of the attachment.

Name

String

File name of the attachment.

Size

String

Size of the attachment.

### Email Attachment Email attachment to include in a message.
FieldTypeDescriptionDefault ValueRequired

Content

Binary

Binary content of the attachment.

x

Name

String

File name of the attachment.

x

Filetype

String

MIME type of the attachment.

## See Also - [Gmail Connector Overview](https://docs.mulesoft.com/gmail-connector/latest/) - [Salesforce Help](https://help.salesforce.com) --- product: Gmail Connector version: 1.0 --- # Using Anypoint Studio to Configure Gmail Connector 1.0 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure a source for the connector’s flow](#configure-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). 6. [Configure the other connector fields](#configure-other-fields). When you run the connector, you can view the app log to check for problems in real time, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Gmail Reference](https://docs.mulesoft.com/gmail-connector/1.0/gmail-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Gmail Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In the **Add Dependencies to Project** window, type `gmail` in the search field. 3. Click **Gmail** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Gmail Connector: - HTTP Listener Initiates a flow each time it receives a request on the configured host and port - Scheduler Initiates a flow when a time-based condition is met For example, to configure an HTTP Listener source, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of the HTTP Listener source in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you are specifying an action for that connector to perform. To add an operation for Gmail Connector, follow these steps: 1. In the **Mule Palette** view, select **Gmail** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Gmail system. Gmail Connector supports Oauth2c authentication. To configure the global element for Gmail Connector, follow these steps: 1. Select the operation in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, in **Connection**, select the [Oauth2c](#oauth2c) authentication method to configure: You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### Oauth2c Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). Enter the following information on the **General** tab of the **Global Element Properties** screen to configure Oauth2c authentication:
FieldUser Action

Name

Enter the configuration name.

Connection

Select Oauth2c.

Consumer Key

OAuth consumer key, as registered with the service provider.

Consumer Secret

OAuth consumer secret, as registered with the service provider.

Listener Config

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

Callback Path

Path of the access token callback endpoint.

Authorize Path

Path of the HTTP endpoint that triggers the OAuth dance.

## Configure Additional Connector Fields After you configure a global element for Gmail, configure the other required fields for the connector. The required fields vary depending on which connector operation you use. ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) - [Gmail Connector Reference](https://docs.mulesoft.com/gmail-connector/1.0/gmail-connector-reference) - [Salesforce Help](https://help.salesforce.com) --- product: Gmail Connector version: 1.1 is-latest-version: true --- # Using Anypoint Studio to Configure Gmail Connector 1.1 > For the full documentation index, see: https://docs.mulesoft.com/llms.txt Anypoint Studio (Studio) editors help you design and update your Mule applications, properties, and configuration files. To add and configure a connector in Studio: 1. [Create a Mule project](#create-mule-project). 2. [Add the connector to your Mule project](#add-connector-to-project). 3. [Configure a source for the connector’s flow](#configure-source). 4. [Add a connector operation to the flow](#add-connector-operation). 5. [Configure a global element for the connector](#configure-global-element). 6. [Configure the other connector fields](#configure-other-fields). When you run the connector, you can view the app log to check for problems in real time, as described in [View the App Log](#view-app-log). If you are new to configuring connectors in Studio, see [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio). If, after reading this topic, you need additional information about the connector fields, see the [Gmail Reference](https://docs.mulesoft.com/gmail-connector/latest/gmail-connector-reference). ## Create a Mule Project In Studio, create a new Mule project in which to add and configure the connector: 1. In Studio, select **File > New > Mule Project**. 2. Enter a name for your Mule project and click **Finish**. ## Add the Connector to Your Mule Project Add Gmail Connector to your Mule project to automatically populate the XML code with the connector’s namespace and schema location and add the required dependencies to the project’s `pom.xml` file: 1. In the **Mule Palette** view, click **(X) Search in Exchange**. 2. In the **Add Dependencies to Project** window, type `gmail` in the search field. 3. Click **Gmail** in **Available modules**. 4. Click **Add**. 5. Click **Finish**. Adding a connector to a Mule project in Studio does not make that connector available to other projects in your Studio workspace. ## Configure a Source A source initiates a flow when a specified condition is met. You can configure one of these sources to use with Gmail Connector: - HTTP Listener Initiates a flow each time it receives a request on the configured host and port - Scheduler Initiates a flow when a time-based condition is met For example, to configure an HTTP Listener source, follow these steps: 1. In the **Mule Palette** view, select **HTTP > Listener**. 2. Drag **Listener** to the Studio canvas. 3. On the **Listener** configuration screen, optionally change the value of the **Display Name** field. 4. Specify a value for the **Path** field. 5. Click the plus sign (**+**) next to the **Connector configuration** field to configure a global element that can be used by all instances of the HTTP Listener source in the app. 6. On the **General** tab, specify connection information for the connector. 7. On the **TLS** tab, optionally specify the TLS information for the connector. 8. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 9. Click **Test Connection** to confirm that Mule can connect with the specified server. 10. Click **OK**. ## Add a Connector Operation to the Flow When you add a connector operation to your flow, you are specifying an action for that connector to perform. To add an operation for Gmail Connector, follow these steps: 1. In the **Mule Palette** view, select **Gmail** and then select the desired operation. 2. Drag the operation onto the Studio canvas to the right of the input source. ## Configure a Global Element for the Connector When you configure a connector, configure a global element that all instances of that connector in the app can use. Configuring a global element requires you to provide the authentication credentials that the connector requires to access the target Gmail system. Gmail Connector supports Oauth2c authentication. To configure the global element for Gmail Connector, follow these steps: 1. Select the operation in the Studio canvas. 2. In the configuration screen for the operation, click the plus sign (**+**) next to the **Connector configuration** field to access the global element configuration fields. 3. On the **General** tab, in **Connection**, select the [Oauth2c](#oauth2c) authentication method to configure: You can reference a configuration file that contains ANT-style property placeholders (recommended), or you can enter your authorization credentials in the global configuration properties. For information about the benefits of using property placeholders and how to configure them, see [Anypoint Connector Configuration](https://docs.mulesoft.com/connectors/introduction/intro-connector-configuration-overview). 4. On the **Advanced** tab, optionally specify reconnection information, including a reconnection strategy. 5. Click **Test Connection** to confirm that Mule can connect with the specified server. 6. Click **OK**. ### Oauth2c Use OAuth 2.0 to delegate user authentication to the service hosting the user account. For more information, refer to [Configuring OAuth 2.0 for Connectors](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2), [Configuring OAuth 2.0 for Connectors on CloudHub](https://docs.mulesoft.com/connectors/introduction/intro-config-oauth2-cloudhub), or [OAuth Support in the SDK](https://docs.mulesoft.com/mule-sdk/latest/oauth). Enter the following information on the **General** tab of the **Global Element Properties** screen to configure Oauth2c authentication:
FieldUser Action

Name

Enter the configuration name.

Connection

Select Oauth2c.

Consumer Key

OAuth consumer key, as registered with the service provider.

Consumer Secret

OAuth consumer secret, as registered with the service provider.

Listener Config

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

Callback Path

Path of the access token callback endpoint.

Authorize Path

Path of the HTTP endpoint that triggers the OAuth dance.

## Configure Additional Connector Fields After you configure a global element for Gmail, configure the other required fields for the connector. The required fields vary depending on which connector operation you use. ## View the App Log To check for problems, you can view the app log as follows: - If you’re running the app from Anypoint Platform, the app log output is visible in the Anypoint Studio console window. - If you’re running the app using Mule from the command line, the app log output is visible in your OS console. Unless the log file path is customized in the app’s log file (`log4j2.xml`), you can also view the app log in the default location `MULE_HOME/logs/.log`. You can configure the location of the log path in the app log file `log4j2.xml`. ## See Also - [Introduction to Anypoint Connectors](https://docs.mulesoft.com/connectors/introduction/introduction-to-anypoint-connectors) - [Using Anypoint Studio to Configure a Connector](https://docs.mulesoft.com/connectors/introduction/intro-config-use-studio) - [Gmail Connector Reference](https://docs.mulesoft.com/gmail-connector/latest/gmail-connector-reference) - [Salesforce Help](https://help.salesforce.com)