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]

Configuring Options

Camel components are configured on two separate levels:

  • component level

  • endpoint level

Configuring Component Options

The component level is the highest level which holds general and common configurations that are inherited by the endpoints. For example a component may have security settings, credentials for authentication, urls for network connection and so forth.

Some components only have a few options, and others may have many. Because components typically have pre configured defaults that are commonly used, then you may often only need to configure a few options on a component; or none at all.

Configuring components can be done with the Component DSL, in a configuration file (application.properties|yaml), or directly with Java code.

Configuring Endpoint Options

Where you find yourself configuring the most is on endpoints, as endpoints often have many options, which allows you to configure what you need the endpoint to do. The options are also categorized into whether the endpoint is used as consumer (from) or as a producer (to), or used for both.

Configuring endpoints is most often done directly in the endpoint URI as path and query parameters. You can also use the Endpoint DSL as a type safe way of configuring endpoints.

A good practice when configuring options is to use Property Placeholders, which allows to not hardcode urls, port numbers, sensitive information, and other settings. In other words placeholders allows to externalize the configuration from your code, and gives more flexibility and reuse.

The following two sections lists all the options, firstly for the component followed by the endpoint.

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.

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.

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.

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

Endpoint Options

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 (common)

Required What kind of operation to perform.

Enum values:

  • THREADS

  • MESSAGES

  • ATTACHMENTS

  • LABELS

  • HISTORY

  • DRAFTS

  • USERS

GoogleMailApiName

methodName (common)

Required What sub operation to use for the selected operation.

Enum values:

  • 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.

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.

boolean

exceptionHandler (consumer (advanced))

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 (advanced))

Sets the exchange pattern when the consumer creates an exchange.

Enum values:

  • InOnly

  • InOut

  • InOptionalOut

ExchangePattern

pollStrategy (consumer (advanced))

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.

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.

long

greedy (scheduler)

If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages.

boolean

initialDelay (scheduler)

Milliseconds before the first poll starts.

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.

Enum values:

  • TRACE

  • DEBUG

  • INFO

  • WARN

  • ERROR

  • OFF

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.

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.

boolean

timeUnit (scheduler)

Time unit for initialDelay and delay options.

Enum values:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

TimeUnit

useFixedDelay (scheduler)

Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details.

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

Each API is documented in the following sections to come.

API: attachments

Both producer and consumer are supported

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, followed by detailed syntax for each method. (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 get

Signatures:

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

The google-mail/get API method has the parameters listed in the table below:

Parameter Description Type

id

The ID of the attachment

String

messageId

The ID of the message containing the attachment

String

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 google-mail API can also use any of the Query Parameters (26 parameters).

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 is defined in the syntax as follows:

google-mail:drafts/methodName?[parameters]

The 6 method(s) is listed in the table below, followed by detailed syntax for each method. (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 create

Signatures:

  • 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);

The google-mail/create API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.gmail.model.Draft media metadata or null if none

Draft

mediaContent

The media HTTP content or null if none

AbstractInputStreamContent

userId

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

String

Method delete

Signatures:

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

The google-mail/delete API method has the parameters listed in the table below:

Parameter Description Type

id

The ID of the draft to delete

String

userId

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

String

Method get

Signatures:

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

The google-mail/get API method has the parameters listed in the table below:

Parameter Description Type

id

The ID of the draft to retrieve

String

userId

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

String

Method list

Signatures:

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

The google-mail/list API method has the parameters listed in the table below:

Parameter Description Type

userId

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

String

Method send

Signatures:

  • 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);

The google-mail/send API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.gmail.model.Draft media metadata or null if none

Draft

mediaContent

The media HTTP content or null if none

AbstractInputStreamContent

userId

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

String

Method update

Signatures:

  • 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 google-mail/update API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.gmail.model.Draft media metadata or null if none

Draft

id

String

mediaContent

The media HTTP content or null if none

AbstractInputStreamContent

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 google-mail API can also use any of the Query Parameters (26 parameters).

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

Both producer and consumer are supported

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, followed by detailed syntax for each method. (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 list

Signatures:

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

The google-mail/list API method has the parameters listed in the table below:

Parameter Description Type

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 google-mail API can also use any of the Query Parameters (26 parameters).

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

Both producer and consumer are supported

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, followed by detailed syntax for each method. (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 create

Signatures:

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

The google-mail/create API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.gmail.model.Label

Label

userId

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

String

Method delete

Signatures:

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

The google-mail/delete API method has the parameters listed in the table below:

Parameter Description Type

id

The ID of the label to delete

String

userId

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

String

Method get

Signatures:

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

The google-mail/get API method has the parameters listed in the table below:

Parameter Description Type

id

The ID of the label to retrieve

String

userId

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

String

Method list

Signatures:

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

The google-mail/list API method has the parameters listed in the table below:

Parameter Description Type

userId

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

String

Method patch

Signatures:

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

The google-mail/patch API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.gmail.model.Label

Label

id

The ID of the label to update

String

userId

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

String

Method update

Signatures:

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

The google-mail/update API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.gmail.model.Label

Label

id

The ID of the label to update

String

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 google-mail API can also use any of the Query Parameters (26 parameters).

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

Both producer and consumer are supported

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, followed by detailed syntax for each method. (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 batchDelete

Signatures:

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

The google-mail/batchDelete API method has the parameters listed in the table below:

Parameter Description Type

batchDeleteMessagesRequest

The com.google.api.services.gmail.model.BatchDeleteMessagesRequest

BatchDeleteMessagesRequest

userId

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

String

Method batchModify

Signatures:

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

The google-mail/batchModify API method has the parameters listed in the table below:

Parameter Description Type

batchModifyMessagesRequest

The com.google.api.services.gmail.model.BatchModifyMessagesRequest

BatchModifyMessagesRequest

userId

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

String

Method delete

Signatures:

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

The google-mail/delete API method has the parameters listed in the table below:

Parameter Description Type

id

The ID of the message to delete

String

userId

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

String

Method get

Signatures:

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

The google-mail/get API method has the parameters listed in the table below:

Parameter Description Type

id

The ID of the message to retrieve

String

userId

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

String

Method gmailImport

Signatures:

  • 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);

The google-mail/gmailImport API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.gmail.model.Message media metadata or null if none

Message

mediaContent

The media HTTP content or null if none

AbstractInputStreamContent

userId

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

String

Method insert

Signatures:

  • 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);

The google-mail/insert API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.gmail.model.Message media metadata or null if none

Message

mediaContent

The media HTTP content or null if none

AbstractInputStreamContent

userId

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

String

Method list

Signatures:

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

The google-mail/list API method has the parameters listed in the table below:

Parameter Description Type

userId

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

String

Method modify

Signatures:

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

The google-mail/modify API method has the parameters listed in the table below:

Parameter Description Type

id

The ID of the message to modify

String

modifyMessageRequest

The com.google.api.services.gmail.model.ModifyMessageRequest

ModifyMessageRequest

userId

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

String

Method send

Signatures:

  • 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);

The google-mail/send API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.gmail.model.Message media metadata or null if none

Message

mediaContent

The media HTTP content or null if none

AbstractInputStreamContent

userId

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

String

Method trash

Signatures:

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

The google-mail/trash API method has the parameters listed in the table below:

Parameter Description Type

id

The ID of the message to Trash

String

userId

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

String

Method untrash

Signatures:

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

The google-mail/untrash API method has the parameters listed in the table below:

Parameter Description Type

id

The ID of the message to remove from Trash

String

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 google-mail API can also use any of the Query Parameters (26 parameters).

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

Both producer and consumer are supported

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, followed by detailed syntax for each method. (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 delete

Signatures:

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

The google-mail/delete API method has the parameters listed in the table below:

Parameter Description Type

id

ID of the Thread to delete

String

userId

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

String

Method get

Signatures:

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

The google-mail/get API method has the parameters listed in the table below:

Parameter Description Type

id

The ID of the thread to retrieve

String

userId

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

String

Method list

Signatures:

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

The google-mail/list API method has the parameters listed in the table below:

Parameter Description Type

userId

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

String

Method modify

Signatures:

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

The google-mail/modify API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.gmail.model.ModifyThreadRequest

ModifyThreadRequest

id

The ID of the thread to modify

String

userId

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

String

Method trash

Signatures:

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

The google-mail/trash API method has the parameters listed in the table below:

Parameter Description Type

id

The ID of the thread to Trash

String

userId

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

String

Method untrash

Signatures:

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

The google-mail/untrash API method has the parameters listed in the table below:

Parameter Description Type

id

The ID of the thread to remove from Trash

String

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 google-mail API can also use any of the Query Parameters (26 parameters).

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

Both producer and consumer are supported

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, followed by detailed syntax for each method. (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 getProfile

Signatures:

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

The google-mail/getProfile API method has the parameters listed in the table below:

Parameter Description Type

userId

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

String

Method stop

Signatures:

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

The google-mail/stop API method has the parameters listed in the table below:

Parameter Description Type

userId

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

String

Method watch

Signatures:

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

The google-mail/watch API method has the parameters listed in the table below:

Parameter Description Type

content

The com.google.api.services.gmail.model.WatchRequest

WatchRequest

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 google-mail API can also use any of the Query Parameters (26 parameters).

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.

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