Google Mail

Since Camel 2.15

Both producer and consumer are supported

The Google Mail component provides access to Gmail via the Google Mail Web APIs.

Google Mail uses the 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 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 OAuth playground.

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

<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://endpoint-prefix/endpoint?[options]

Component options

The Google Mail component supports 10 options, which are listed below.

Name	Description	Default	Type
applicationName (common)	Google mail application name. Example would be camel-google-mail/1.0		String
clientId (common)	Client ID of the mail application		String
configuration (common)	To use the shared configuration		GoogleMailConfiguration
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
lazyStartProducer (producer)	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean
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)	To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleMailClientFactory		GoogleMailClientFactory
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

Name

Description

Default

Type

applicationName (common)

Google mail application name. Example would be camel-google-mail/1.0

String

clientId (common)

Client ID of the mail application

String

configuration (common)

To use the shared configuration

GoogleMailConfiguration

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

lazyStartProducer (producer)

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

boolean

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)

To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleMailClientFactory

GoogleMailClientFactory

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

The Google Mail endpoint is configured using URI syntax:

google-mail:apiName/methodName

with the following path and query parameters:

Path Parameters (2 parameters):

Name	Description	Default	Type
apiName	Required What kind of operation to perform. There are 7 enums and the value can be one of: THREADS, MESSAGES, ATTACHMENTS, LABELS, HISTORY, DRAFTS, USERS		GoogleMailApiName
methodName	Required What sub operation to use for the selected operation. There are 16 enums and the value can be one of: attachments, create, delete, get, getProfile, gmailImport, insert, list, modify, patch, send, stop, trash, untrash, update, watch		String

Name

Description

Default

Type

apiName

Required What kind of operation to perform. There are 7 enums and the value can be one of: THREADS, MESSAGES, ATTACHMENTS, LABELS, HISTORY, DRAFTS, USERS

GoogleMailApiName

methodName

Required What sub operation to use for the selected operation. There are 16 enums and the value can be one of: attachments, create, delete, get, getProfile, gmailImport, insert, list, modify, patch, send, stop, trash, untrash, update, watch

String

Query Parameters (26 parameters):

Name	Description	Default	Type
applicationName (common)	Google mail application name. Example would be camel-google-mail/1.0		String
clientId (common)	Client ID of the mail application		String
inBody (common)	Sets the name of a parameter to be passed in the exchange In Body		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
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
lazyStartProducer (producer)	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	boolean
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

Name

Description

Default

Type

applicationName (common)

Google mail application name. Example would be camel-google-mail/1.0

String

clientId (common)

Client ID of the mail application

String

inBody (common)

Sets the name of a parameter to be passed in the exchange In Body

String

bridgeErrorHandler (consumer)

false

boolean

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

lazyStartProducer (producer)

false

boolean

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.

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 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 apiName/methodName path parameters:

google-mail:apiName/methodName

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

API Name	Type	Description
attachments	Both	The attachments collection of methods
drafts	Both	The drafts collection of methods
history	Both	The history collection of methods
labels	Both	The labels collection of methods
messages	Both	The messages collection of methods
threads	Both	The threads collection of methods
users	Both	The users collection of methods

API Name

Type

Description

attachments

Both

The attachments collection of methods

drafts

Both

The drafts collection of methods

history

Both

The history collection of methods

labels

Both

The labels collection of methods

messages

Both

The messages collection of methods

threads

Both

The threads collection of methods

users

Both

The users collection of methods

Each API is documented in the following sections to come.

API: attachments

Both producer and consumer are 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):

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: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)

Method	Alias	Description
get		Gets the specified message attachment

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:

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

Method

Parameter

Description

Type

get

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 26 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 CamelGoogleMail.parameter. The inBody parameter overrides message header, i.e. the endpoint parameter inBody=myParameterNameHere would override a CamelGoogleMail.myParameterNameHere header.

API: drafts

Both producer and consumer are 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):

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: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)

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

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:

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

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

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

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

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 26 endpoint query option which is listed in the Query Parameters section.

API: history

Both producer and consumer are 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):

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

The history API is defined in the syntax as follows:

google-mail: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)

Method	Alias	Description
list		Lists the history of all changes to the given mailbox

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:

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

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 26 endpoint query option which is listed in the Query Parameters section.

API: labels

Both producer and consumer are 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):

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: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)

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

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:

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

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

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

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

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

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 26 endpoint query option which is listed in the Query Parameters section.

API: messages

Both producer and consumer are 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):

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: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)

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

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:

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

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

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

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

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

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

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 26 endpoint query option which is listed in the Query Parameters section.

API: threads

Both producer and consumer are 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):

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: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)

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

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:

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

Method

Parameter

Description

Type

delete

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

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

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

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

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 26 endpoint query option which is listed in the Query Parameters section.

API: users

Both producer and consumer are 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):

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: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)

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

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:

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

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 26 endpoint query option which is listed in the Query Parameters section.

More Information

For more information on the endpoints and options see API documentation at: https://developers.google.com/gmail/api/v1/reference/

Spring Boot Auto-Configuration

When using google-mail with Spring Boot make sure to use the following Maven dependency to have support for auto configuration:

<dependency>
  <groupId>org.apache.camel.springboot</groupId>
  <artifactId>camel-google-mail-starter</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel core version -->
</dependency>

The component supports 25 options, which are listed below.

Name	Description	Default	Type
camel.component.google-mail-stream.access-token	OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.		String
camel.component.google-mail-stream.application-name	Google mail application name. Example would be camel-google-mail/1.0		String
camel.component.google-mail-stream.autowired-enabled	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
camel.component.google-mail-stream.bridge-error-handler	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
camel.component.google-mail-stream.client-factory	The client Factory. The option is a org.apache.camel.component.google.mail.GoogleMailClientFactory type.		GoogleMailClientFactory
camel.component.google-mail-stream.client-id	Client ID of the mail application		String
camel.component.google-mail-stream.client-secret	Client secret of the mail application		String
camel.component.google-mail-stream.configuration	The configuration. The option is a org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration type.		GoogleMailStreamConfiguration
camel.component.google-mail-stream.enabled	Whether to enable auto configuration of the google-mail-stream component. This is enabled by default.		Boolean
camel.component.google-mail-stream.labels	Comma separated list of labels to take into account		String
camel.component.google-mail-stream.mark-as-read	Mark the message as read once it has been consumed	true	Boolean
camel.component.google-mail-stream.max-results	Max results to be returned	10	Long
camel.component.google-mail-stream.query	The query to execute on gmail box	is:unread	String
camel.component.google-mail-stream.refresh-token	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
camel.component.google-mail.access-token	OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.		String
camel.component.google-mail.application-name	Google mail application name. Example would be camel-google-mail/1.0		String
camel.component.google-mail.autowired-enabled	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
camel.component.google-mail.bridge-error-handler	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
camel.component.google-mail.client-factory	To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleMailClientFactory. The option is a org.apache.camel.component.google.mail.GoogleMailClientFactory type.		GoogleMailClientFactory
camel.component.google-mail.client-id	Client ID of the mail application		String
camel.component.google-mail.client-secret	Client secret of the mail application		String
camel.component.google-mail.configuration	To use the shared configuration. The option is a org.apache.camel.component.google.mail.GoogleMailConfiguration type.		GoogleMailConfiguration
camel.component.google-mail.enabled	Whether to enable auto configuration of the google-mail component. This is enabled by default.		Boolean
camel.component.google-mail.lazy-start-producer	Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.	false	Boolean
camel.component.google-mail.refresh-token	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

Name

Description

Default

Type

camel.component.google-mail-stream.access-token

OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.

String

camel.component.google-mail-stream.application-name

Google mail application name. Example would be camel-google-mail/1.0

String

camel.component.google-mail-stream.autowired-enabled

true

Boolean

camel.component.google-mail-stream.bridge-error-handler

false

Boolean

camel.component.google-mail-stream.client-factory

The client Factory. The option is a org.apache.camel.component.google.mail.GoogleMailClientFactory type.

GoogleMailClientFactory

camel.component.google-mail-stream.client-id

Client ID of the mail application

String

camel.component.google-mail-stream.client-secret

Client secret of the mail application

String

camel.component.google-mail-stream.configuration

The configuration. The option is a org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration type.

GoogleMailStreamConfiguration

camel.component.google-mail-stream.enabled

Whether to enable auto configuration of the google-mail-stream component. This is enabled by default.

Boolean

camel.component.google-mail-stream.labels

Comma separated list of labels to take into account

String

camel.component.google-mail-stream.mark-as-read

Mark the message as read once it has been consumed

true

Boolean

camel.component.google-mail-stream.max-results

Max results to be returned

Long

camel.component.google-mail-stream.query

The query to execute on gmail box

is:unread

String

camel.component.google-mail-stream.refresh-token

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

camel.component.google-mail.access-token

OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.

String

camel.component.google-mail.application-name

Google mail application name. Example would be camel-google-mail/1.0

String

camel.component.google-mail.autowired-enabled

true

Boolean

camel.component.google-mail.bridge-error-handler

false

Boolean

camel.component.google-mail.client-factory

To use the GoogleCalendarClientFactory as factory for creating the client. Will by default use BatchGoogleMailClientFactory. The option is a org.apache.camel.component.google.mail.GoogleMailClientFactory type.

GoogleMailClientFactory

camel.component.google-mail.client-id

Client ID of the mail application

String

camel.component.google-mail.client-secret

Client secret of the mail application

String

camel.component.google-mail.configuration

To use the shared configuration. The option is a org.apache.camel.component.google.mail.GoogleMailConfiguration type.

GoogleMailConfiguration

camel.component.google-mail.enabled

Whether to enable auto configuration of the google-mail component. This is enabled by default.

Boolean

camel.component.google-mail.lazy-start-producer

false

Boolean

camel.component.google-mail.refresh-token

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