GoogleMail

Available as of Camel 2.15

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>
        <version>2.15-SNAPSHOT</version>
</dependency>

The GoogleMail Component uses the following URI format:

google-mail://endpoint-prefix/endpoint?[options]

Endpoint prefix can be one of:

The GoogleMail Component can be configured with the options below. These options can be provided using the component's bean property configuration of type org.apache.camel.component.google.mail.GoogleMailConfiguration.

Producer endpoints can use endpoint prefixes followed by endpoint names and associated options described next. A shorthand alias can be used for some endpoints. The endpoint URI MUST contain a prefix.

Endpoint options that are not mandatory are denoted by []. When there are no mandatory options for an endpoint, one of the set of [] options MUST be provided. Producer endpoints can also use a special option inBody that in turn should contain the name of the endpoint option whose value will be contained in the Camel Exchange In message.

Any of the endpoint options can be provided in either the endpoint URI, or dynamically in a message header. The message header name must be of the format CamelGoogleMail.<option>. Note that the inBody option overrides message header, i.e. the endpoint option inBody=option would override a CamelGoogleMail.option header.

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

The following endpoints can be invoked with the prefix attachments as follows:

google-mail://attachments/endpoint?[options]

The following endpoints can be invoked with the prefix drafts as follows:

google-mail://drafts/endpoint?[options]

The following endpoints can be invoked with the prefix history as follows:

google-mail://history/endpoint?[options]

The following endpoints can be invoked with the prefix labels as follows:

google-mail://labels/endpoint?[options]

The following endpoints can be invoked with the prefix messages as follows:

google-mail://messages/endpoint?[options]

The following endpoints can be invoked with the prefix threads as follows:

google-mail://threads/endpoint?[options]

The following endpoints can be invoked with the prefix users as follows:

google-mail://users/endpoint?[options]

Any of the producer endpoints can be used as a consumer endpoint. Consumer endpoints can use Scheduled Poll Consumer Options with a consumer. prefix to schedule endpoint invocation. Consumer endpoints that return an array or collection will generate one exchange per element, and their routes will be executed once for each exchange.

Any URI option can be provided in a message header for producer endpoints with a CamelGoogleMail. prefix.

All result message bodies utilize objects provided by the underlying APIs used by the GoogleMailComponent. Producer endpoints can specify the option name for incoming message body in the inBody endpoint URI parameter. For endpoints that return an array or collection, a consumer endpoint will map every element to distinct messages.