[[google-mail-stream-component]]
= Google Mail Stream Component
//THIS FILE IS COPIED: EDIT THE SOURCE FILE:
:page-source: components/camel-google/camel-google-mail/src/main/docs/google-mail-stream-component.adoc
:docTitle: Google Mail Stream
:artifactId: camel-google-mail
:description: Poll for incoming messages in Google Mail.
:since: 2.22
:supportLevel: Stable
:component-header: Only consumer is supported
include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/google-mail-stream.adoc[opts=optional]
//Manually maintained attributes
:group: Google

*Since Camel {since}*

*{component-header}*

The Google Mail component provides access
to http://gmail.com/[Gmail] via
the https://developers.google.com/gmail/api/v1/reference/[Google Mail
Web APIs]. This component provides the streaming feature for Messages.

Google Mail uses
the https://developers.google.com/accounts/docs/OAuth2[OAuth 2.0
protocol] for authenticating a Google account and authorizing access to
user data. Before you can use this component, you will need
to https://developers.google.com/gmail/api/auth/web-server[create an
account and generate OAuth credentials]. Credentials comprise of a
clientId, clientSecret, and a refreshToken. A handy resource for
generating a long-lived refreshToken is
the https://developers.google.com/oauthplayground[OAuth playground].

Maven users will need to add the following dependency to their pom.xml
for this component:

[source,xml]
----
<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-google-mail</artifactId>
    <!-- use the same version as your Camel core version -->
    <version>x.y.z</version>
</dependency>
----

== URI Format

The GoogleMail Component uses the following URI format:

----
google-mail-stream://index?[options]
----

== Component options


// component options: START
The Google Mail Stream component supports 13 options, which are listed below.



[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *applicationName* (consumer) | Google mail application name. Example would be camel-google-mail/1.0 |  | String
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
| *clientId* (consumer) | Client ID of the mail application |  | String
| *labels* (consumer) | Comma separated list of labels to take into account |  | String
| *markAsRead* (consumer) | Mark the message as read once it has been consumed | true | boolean
| *maxResults* (consumer) | Max results to be returned | 10 | long
| *query* (consumer) | The query to execute on gmail box | is:unread | String
| *autowiredEnabled* (advanced) | Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc. | true | boolean
| *clientFactory* (advanced) | The client Factory |  | GoogleMailClientFactory
| *configuration* (advanced) | The configuration |  | GoogleMailStreamConfiguration
| *accessToken* (security) | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. |  | String
| *clientSecret* (security) | Client secret of the mail application |  | String
| *refreshToken* (security) | OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. |  | String
|===
// component options: END




// endpoint options: START
The Google Mail Stream endpoint is configured using URI syntax:

----
google-mail-stream:index
----

with the following path and query parameters:

=== Path Parameters (1 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *index* | *Required* Currently not in use |  | String
|===


=== Query Parameters (28 parameters):


[width="100%",cols="2,5,^1,2",options="header"]
|===
| Name | Description | Default | Type
| *applicationName* (consumer) | Google mail application name. Example would be camel-google-mail/1.0 |  | String
| *bridgeErrorHandler* (consumer) | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored. | false | boolean
| *clientId* (consumer) | Client ID of the mail application |  | String
| *labels* (consumer) | Comma separated list of labels to take into account |  | String
| *markAsRead* (consumer) | Mark the message as read once it has been consumed | true | boolean
| *maxResults* (consumer) | Max results to be returned | 10 | long
| *query* (consumer) | The query to execute on gmail box | is:unread | String
| *sendEmptyMessageWhenIdle* (consumer) | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. | false | boolean
| *exceptionHandler* (consumer) | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |  | ExceptionHandler
| *exchangePattern* (consumer) | Sets the exchange pattern when the consumer creates an exchange. There are 3 enums and the value can be one of: InOnly, InOut, InOptionalOut |  | ExchangePattern
| *pollStrategy* (consumer) | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. |  | PollingConsumerPollStrategy
| *backoffErrorThreshold* (scheduler) | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. |  | int
| *backoffIdleThreshold* (scheduler) | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. |  | int
| *backoffMultiplier* (scheduler) | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. |  | int
| *delay* (scheduler) | Milliseconds before the next poll. | 500 | long
| *greedy* (scheduler) | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. | false | boolean
| *initialDelay* (scheduler) | Milliseconds before the first poll starts. | 1000 | long
| *repeatCount* (scheduler) | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. | 0 | long
| *runLoggingLevel* (scheduler) | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. There are 6 enums and the value can be one of: TRACE, DEBUG, INFO, WARN, ERROR, OFF | TRACE | LoggingLevel
| *scheduledExecutorService* (scheduler) | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. |  | ScheduledExecutorService
| *scheduler* (scheduler) | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler | none | Object
| *schedulerProperties* (scheduler) | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. |  | Map
| *startScheduler* (scheduler) | Whether the scheduler should be auto started. | true | boolean
| *timeUnit* (scheduler) | Time unit for initialDelay and delay options. There are 7 enums and the value can be one of: NANOSECONDS, MICROSECONDS, MILLISECONDS, SECONDS, MINUTES, HOURS, DAYS | MILLISECONDS | TimeUnit
| *useFixedDelay* (scheduler) | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. | true | boolean
| *accessToken* (security) | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. |  | String
| *clientSecret* (security) | Client secret of the mail application |  | String
| *refreshToken* (security) | OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. |  | String
|===




=== API Parameters (7 APIs):

The Google Mail Stream endpoint is an API based component and has additional parameters based on which API name and API method is used.
The API name and API method is located in the endpoint URI as the null path parameters:

----
google-mail-stream:index
----

There are 7 API names as listed in the table below:

[width="100%",cols="2,2,6",options="header"]
|===
| API Name | Type | Description
| *attachments* | Consumer | The attachments collection of methods
| *drafts* | Consumer | The drafts collection of methods
| *history* | Consumer | The history collection of methods
| *labels* | Consumer | The labels collection of methods
| *messages* | Consumer | The messages collection of methods
| *threads* | Consumer | The threads collection of methods
| *users* | Consumer | The users collection of methods
|===

Each API is documented in the following sections to come.


==== API: attachments

*Only consumer is supported*




The attachments API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

com.google.api.services.gmail.Gmail.Users.Messages.Attachments.Get get(String userId, String messageId, String id);

----

The attachments API is defined in the syntax as follows:

----
google-mail-stream:attachments/methodName?[parameters]
----

The 1 method(s) is listed in the table below.
(API methods can have a shorthand alias name which can be used in the syntax instead of the name)

[width="100%",cols="2,2,6",options="header"]
|===
| Method | Alias | Description
| *get* |  | Gets the specified message attachment
|===

The attachments API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| get | *id* |  The ID of the attachment | String
| get | *messageId* |  The ID of the message containing the attachment | String
| get | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===

In addition to the parameters above, the attachments API can also use from the 28 endpoint query option
which is listed in the _Query Parameters_ section.

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format `CamelGoogleMailStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleMailStream.myParameterNameHere` header.



==== API: drafts

*Only consumer is supported*




The drafts API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

com.google.api.services.gmail.Gmail.Users.Drafts.Create create(String userId, com.google.api.services.gmail.model.Draft content);

com.google.api.services.gmail.Gmail.Users.Drafts.Create create(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent);

com.google.api.services.gmail.Gmail.Users.Drafts.Delete delete(String userId, String id);

com.google.api.services.gmail.Gmail.Users.Drafts.Get get(String userId, String id);

com.google.api.services.gmail.Gmail.Users.Drafts.List list(String userId);

com.google.api.services.gmail.Gmail.Users.Drafts.Send send(String userId, com.google.api.services.gmail.model.Draft content);

com.google.api.services.gmail.Gmail.Users.Drafts.Send send(String userId, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent);

com.google.api.services.gmail.Gmail.Users.Drafts.Update update(String userId, String id, com.google.api.services.gmail.model.Draft content);

com.google.api.services.gmail.Gmail.Users.Drafts.Update update(String userId, String id, com.google.api.services.gmail.model.Draft content, com.google.api.client.http.AbstractInputStreamContent mediaContent);

----

The drafts API is defined in the syntax as follows:

----
google-mail-stream:drafts/methodName?[parameters]
----

The 6 method(s) is listed in the table below.
(API methods can have a shorthand alias name which can be used in the syntax instead of the name)

[width="100%",cols="2,2,6",options="header"]
|===
| Method | Alias | Description
| *create* |  | Creates a new draft with the DRAFT label
| *delete* |  | Immediately and permanently deletes the specified draft
| *get* |  | Gets the specified draft
| *list* |  | Lists the drafts in the user's mailbox
| *send* |  | Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers
| *update* |  | Replaces a draft's content
|===

The drafts API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| create | *content* |  The com.google.api.services.gmail.model.Draft media metadata or null if none | Draft
| create | *mediaContent* |  The media HTTP content or null if none | AbstractInputStreamContent
| create | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| delete | *id* |  The ID of the draft to delete | String
| delete | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| get | *id* |  The ID of the draft to retrieve | String
| get | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| list | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| send | *content* |  The com.google.api.services.gmail.model.Draft media metadata or null if none | Draft
| send | *mediaContent* |  The media HTTP content or null if none | AbstractInputStreamContent
| send | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| update | *content* |  The com.google.api.services.gmail.model.Draft media metadata or null if none | Draft
| update | *id* |   | String
| update | *mediaContent* |  The media HTTP content or null if none | AbstractInputStreamContent
| update | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===

In addition to the parameters above, the drafts API can also use from the 28 endpoint query option
which is listed in the _Query Parameters_ section.

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format `CamelGoogleMailStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleMailStream.myParameterNameHere` header.



==== API: history

*Only consumer is supported*




The history API has 1 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

com.google.api.services.gmail.Gmail.Users.History.List list(String userId);

----

The history API is defined in the syntax as follows:

----
google-mail-stream:history/methodName?[parameters]
----

The 1 method(s) is listed in the table below.
(API methods can have a shorthand alias name which can be used in the syntax instead of the name)

[width="100%",cols="2,2,6",options="header"]
|===
| Method | Alias | Description
| *list* |  | Lists the history of all changes to the given mailbox
|===

The history API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| list | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===

In addition to the parameters above, the history API can also use from the 28 endpoint query option
which is listed in the _Query Parameters_ section.

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format `CamelGoogleMailStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleMailStream.myParameterNameHere` header.



==== API: labels

*Only consumer is supported*




The labels API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

com.google.api.services.gmail.Gmail.Users.Labels.Create create(String userId, com.google.api.services.gmail.model.Label content);

com.google.api.services.gmail.Gmail.Users.Labels.Delete delete(String userId, String id);

com.google.api.services.gmail.Gmail.Users.Labels.Get get(String userId, String id);

com.google.api.services.gmail.Gmail.Users.Labels.List list(String userId);

com.google.api.services.gmail.Gmail.Users.Labels.Patch patch(String userId, String id, com.google.api.services.gmail.model.Label content);

com.google.api.services.gmail.Gmail.Users.Labels.Update update(String userId, String id, com.google.api.services.gmail.model.Label content);

----

The labels API is defined in the syntax as follows:

----
google-mail-stream:labels/methodName?[parameters]
----

The 6 method(s) is listed in the table below.
(API methods can have a shorthand alias name which can be used in the syntax instead of the name)

[width="100%",cols="2,2,6",options="header"]
|===
| Method | Alias | Description
| *create* |  | Creates a new label
| *delete* |  | Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to
| *get* |  | Gets the specified label
| *list* |  | Lists all labels in the user's mailbox
| *patch* |  | Updates the specified label
| *update* |  | Updates the specified label
|===

The labels API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| create | *content* |  The com.google.api.services.gmail.model.Label | Label
| create | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| delete | *id* |  The ID of the label to delete | String
| delete | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| get | *id* |  The ID of the label to retrieve | String
| get | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| list | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| patch | *content* |  The com.google.api.services.gmail.model.Label | Label
| patch | *id* |  The ID of the label to update | String
| patch | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| update | *content* |  The com.google.api.services.gmail.model.Label | Label
| update | *id* |  The ID of the label to update | String
| update | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===

In addition to the parameters above, the labels API can also use from the 28 endpoint query option
which is listed in the _Query Parameters_ section.

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format `CamelGoogleMailStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleMailStream.myParameterNameHere` header.



==== API: messages

*Only consumer is supported*




The messages API has 11 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

com.google.api.services.gmail.Gmail.Users.Messages.BatchDelete batchDelete(String userId, com.google.api.services.gmail.model.BatchDeleteMessagesRequest content);

com.google.api.services.gmail.Gmail.Users.Messages.BatchModify batchModify(String userId, com.google.api.services.gmail.model.BatchModifyMessagesRequest content);

com.google.api.services.gmail.Gmail.Users.Messages.Delete delete(String userId, String id);

com.google.api.services.gmail.Gmail.Users.Messages.Get get(String userId, String id);

com.google.api.services.gmail.Gmail.Users.Messages.GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content);

com.google.api.services.gmail.Gmail.Users.Messages.GmailImport gmailImport(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent);

com.google.api.services.gmail.Gmail.Users.Messages.Insert insert(String userId, com.google.api.services.gmail.model.Message content);

com.google.api.services.gmail.Gmail.Users.Messages.Insert insert(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent);

com.google.api.services.gmail.Gmail.Users.Messages.List list(String userId);

com.google.api.services.gmail.Gmail.Users.Messages.Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyMessageRequest content);

com.google.api.services.gmail.Gmail.Users.Messages.Send send(String userId, com.google.api.services.gmail.model.Message content);

com.google.api.services.gmail.Gmail.Users.Messages.Send send(String userId, com.google.api.services.gmail.model.Message content, com.google.api.client.http.AbstractInputStreamContent mediaContent);

com.google.api.services.gmail.Gmail.Users.Messages.Trash trash(String userId, String id);

com.google.api.services.gmail.Gmail.Users.Messages.Untrash untrash(String userId, String id);

----

The messages API is defined in the syntax as follows:

----
google-mail-stream:messages/methodName?[parameters]
----

The 11 method(s) is listed in the table below.
(API methods can have a shorthand alias name which can be used in the syntax instead of the name)

[width="100%",cols="2,2,6",options="header"]
|===
| Method | Alias | Description
| *batchDelete* |  | Deletes many messages by message ID
| *batchModify* |  | Modifies the labels on the specified messages
| *delete* |  | Immediately and permanently deletes the specified message
| *get* |  | Gets the specified message
| *gmailImport* |  | Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP
| *insert* |  | Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification
| *list* |  | Lists the messages in the user's mailbox
| *modify* |  | Modifies the labels on the specified message
| *send* |  | Sends the specified message to the recipients in the To, Cc, and Bcc headers
| *trash* |  | Moves the specified message to the trash
| *untrash* |  | Removes the specified message from the trash
|===

The messages API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| batchDelete | *batchDeleteMessagesRequest* |  The com.google.api.services.gmail.model.BatchDeleteMessagesRequest | BatchDeleteMessagesRequest
| batchDelete | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| batchModify | *batchModifyMessagesRequest* |  The com.google.api.services.gmail.model.BatchModifyMessagesRequest | BatchModifyMessagesRequest
| batchModify | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| delete | *id* |  The ID of the message to delete | String
| delete | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| get | *id* |  The ID of the message to retrieve | String
| get | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| gmailImport | *content* |  The com.google.api.services.gmail.model.Message media metadata or null if none | Message
| gmailImport | *mediaContent* |  The media HTTP content or null if none | AbstractInputStreamContent
| gmailImport | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| insert | *content* |  The com.google.api.services.gmail.model.Message media metadata or null if none | Message
| insert | *mediaContent* |  The media HTTP content or null if none | AbstractInputStreamContent
| insert | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| list | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| modify | *id* |  The ID of the message to modify | String
| modify | *modifyMessageRequest* |  The com.google.api.services.gmail.model.ModifyMessageRequest | ModifyMessageRequest
| modify | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| send | *content* |  The com.google.api.services.gmail.model.Message media metadata or null if none | Message
| send | *mediaContent* |  The media HTTP content or null if none | AbstractInputStreamContent
| send | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| trash | *id* |  The ID of the message to Trash | String
| trash | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| untrash | *id* |  The ID of the message to remove from Trash | String
| untrash | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===

In addition to the parameters above, the messages API can also use from the 28 endpoint query option
which is listed in the _Query Parameters_ section.

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format `CamelGoogleMailStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleMailStream.myParameterNameHere` header.



==== API: threads

*Only consumer is supported*




The threads API has 6 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

com.google.api.services.gmail.Gmail.Users.Threads.Delete delete(String userId, String id);

com.google.api.services.gmail.Gmail.Users.Threads.Get get(String userId, String id);

com.google.api.services.gmail.Gmail.Users.Threads.List list(String userId);

com.google.api.services.gmail.Gmail.Users.Threads.Modify modify(String userId, String id, com.google.api.services.gmail.model.ModifyThreadRequest content);

com.google.api.services.gmail.Gmail.Users.Threads.Trash trash(String userId, String id);

com.google.api.services.gmail.Gmail.Users.Threads.Untrash untrash(String userId, String id);

----

The threads API is defined in the syntax as follows:

----
google-mail-stream:threads/methodName?[parameters]
----

The 6 method(s) is listed in the table below.
(API methods can have a shorthand alias name which can be used in the syntax instead of the name)

[width="100%",cols="2,2,6",options="header"]
|===
| Method | Alias | Description
| *delete* |  | Immediately and permanently deletes the specified thread
| *get* |  | Gets the specified thread
| *list* |  | Lists the threads in the user's mailbox
| *modify* |  | Modifies the labels applied to the thread
| *trash* |  | Moves the specified thread to the trash
| *untrash* |  | Removes the specified thread from the trash
|===

The threads API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| delete | *id* |  ID of the Thread to delete | String
| delete | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| get | *id* |  The ID of the thread to retrieve | String
| get | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| list | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| modify | *content* |  The com.google.api.services.gmail.model.ModifyThreadRequest | ModifyThreadRequest
| modify | *id* |  The ID of the thread to modify | String
| modify | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| trash | *id* |  The ID of the thread to Trash | String
| trash | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| untrash | *id* |  The ID of the thread to remove from Trash | String
| untrash | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===

In addition to the parameters above, the threads API can also use from the 28 endpoint query option
which is listed in the _Query Parameters_ section.

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format `CamelGoogleMailStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleMailStream.myParameterNameHere` header.



==== API: users

*Only consumer is supported*




The users API has 3 method(s) which is represented by the following method signatures
(an API method may have multiple signatures due to overloading):

[source,java]
----

com.google.api.services.gmail.Gmail.Users.GetProfile getProfile(String userId);

com.google.api.services.gmail.Gmail.Users.Stop stop(String userId);

com.google.api.services.gmail.Gmail.Users.Watch watch(String userId, com.google.api.services.gmail.model.WatchRequest content);

----

The users API is defined in the syntax as follows:

----
google-mail-stream:users/methodName?[parameters]
----

The 3 method(s) is listed in the table below.
(API methods can have a shorthand alias name which can be used in the syntax instead of the name)

[width="100%",cols="2,2,6",options="header"]
|===
| Method | Alias | Description
| *getProfile* |  | Gets the current user's Gmail profile
| *stop* |  | Stop receiving push notifications for the given user mailbox
| *watch* |  | Set up or update a push notification watch on the given user mailbox
|===

The users API method(s) has the following set of parameters listed in the table below:
[width="100%",cols="2,2,4,2",options="header"]
|===
| Method | Parameter | Description | Type
| getProfile | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| stop | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
| watch | *content* |  The com.google.api.services.gmail.model.WatchRequest | WatchRequest
| watch | *userId* |  The user's email address. The special value me can be used to indicate the authenticated user. default: me | String
|===

In addition to the parameters above, the users API can also use from the 28 endpoint query option
which is listed in the _Query Parameters_ section.

Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
The message header name must be of the format `CamelGoogleMailStream.parameter`.
The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
would override a `CamelGoogleMailStream.myParameterNameHere` header.
// endpoint options: END

include::{page-component-version}@camel-spring-boot::page$google-mail-starter.adoc[]
