camel-google-mail-kafka-connector sink configuration

Connector Description: Manage messages in Google Mail.

When using camel-google-mail-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-google-mail-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.googlemail.CamelGooglemailSinkConnector

The camel-google-mail sink connector supports 18 options, which are listed below.

Name Description Default Priority

camel.sink.path.apiName

Required What kind of operation to perform One of: [THREADS] [MESSAGES] [ATTACHMENTS] [LABELS] [HISTORY] [DRAFTS] [USERS].

Enum values:

  • THREADS

  • MESSAGES

  • ATTACHMENTS

  • LABELS

  • HISTORY

  • DRAFTS

  • USERS

HIGH

camel.sink.path.methodName

Required What sub operation to use for the selected operation One of: [attachments] [create] [delete] [get] [getProfile] [gmailImport] [insert] [list] [modify] [patch] [send] [stop] [trash] [untrash] [update] [watch].

Enum values:

  • attachments

  • create

  • delete

  • get

  • getProfile

  • gmailImport

  • insert

  • list

  • modify

  • patch

  • send

  • stop

  • trash

  • untrash

  • update

  • watch

HIGH

camel.sink.endpoint.applicationName

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

MEDIUM

camel.sink.endpoint.clientId

Client ID of the mail application.

MEDIUM

camel.sink.endpoint.inBody

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

MEDIUM

camel.sink.endpoint.lazyStartProducer

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

MEDIUM

camel.sink.endpoint.accessToken

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

MEDIUM

camel.sink.endpoint.clientSecret

Client secret of the mail application.

MEDIUM

camel.sink.endpoint.refreshToken

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.

MEDIUM

camel.component.google-mail.applicationName

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

MEDIUM

camel.component.google-mail.clientId

Client ID of the mail application.

MEDIUM

camel.component.google-mail.configuration

To use the shared configuration.

MEDIUM

camel.component.google-mail.lazyStartProducer

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

MEDIUM

camel.component.google-mail.autowiredEnabled

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

MEDIUM

camel.component.google-mail.clientFactory

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

MEDIUM

camel.component.google-mail.accessToken

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

MEDIUM

camel.component.google-mail.clientSecret

Client secret of the mail application.

MEDIUM

camel.component.google-mail.refreshToken

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.

MEDIUM

The camel-google-mail sink connector has no converters out of the box.

The camel-google-mail sink connector has no transforms out of the box.

The camel-google-mail sink connector has no aggregation strategies out of the box.

Back to top