GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder (Camel

All Superinterfaces:

ComponentBuilder<org.apache.camel.component.google.mail.stream.GoogleMailStreamComponent>

All Known Implementing Classes:

GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilderImpl

Enclosing interface:

GoogleMailStreamComponentBuilderFactory
```
public static interface GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder
extends ComponentBuilder<org.apache.camel.component.google.mail.stream.GoogleMailStreamComponent>
```
Builder for the Google Mail Stream component.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method and Description
`default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder`	`accessToken(String accessToken)` OAuth 2 access token.
`default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder`	`applicationName(String applicationName)` Google mail application name.
`default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder`	`basicPropertyBinding(boolean basicPropertyBinding)` Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities.
`default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder`	`bridgeErrorHandler(boolean bridgeErrorHandler)` 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.
`default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder`	`clientFactory(org.apache.camel.component.google.mail.GoogleMailClientFactory clientFactory)` The client Factory.
`default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder`	`clientId(String clientId)` Client ID of the mail application.
`default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder`	`clientSecret(String clientSecret)` Client secret of the mail application.
`default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder`	`configuration(org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration configuration)` The configuration.
`default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder`	`labels(String labels)` Comma separated list of labels to take into account.
`default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder`	`markAsRead(boolean markAsRead)` Mark the message as read once it has been consumed.
`default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder`	`maxResults(long maxResults)` Max results to be returned.
`default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder`	`query(String query)` The query to execute on gmail box.
`default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder`	`refreshToken(String refreshToken)` OAuth 2 refresh token.

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder
build, build, doSetProperty, register

- Method Detail
  - accessToken
```
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder accessToken(String accessToken)
```
    OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. The option is a: java.lang.String type. Group: consumer
  - applicationName
```
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder applicationName(String applicationName)
```
    Google mail application name. Example would be camel-google-mail/1.0. The option is a: java.lang.String type. Group: consumer
  - bridgeErrorHandler
```
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder bridgeErrorHandler(boolean bridgeErrorHandler)
```
    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. The option is a: boolean type. Default: false Group: consumer
  - clientId
```
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder clientId(String clientId)
```
    Client ID of the mail application. The option is a: java.lang.String type. Group: consumer
  - clientSecret
```
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder clientSecret(String clientSecret)
```
    Client secret of the mail application. The option is a: java.lang.String type. Group: consumer
  - labels
```
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder labels(String labels)
```
    Comma separated list of labels to take into account. The option is a: java.lang.String type. Group: consumer
  - markAsRead
```
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder markAsRead(boolean markAsRead)
```
    Mark the message as read once it has been consumed. The option is a: boolean type. Default: false Group: consumer
  - maxResults
```
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder maxResults(long maxResults)
```
    Max results to be returned. The option is a: long type. Default: 10 Group: consumer
  - query
```
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder query(String query)
```
    The query to execute on gmail box. The option is a: java.lang.String type. Default: is:unread Group: consumer
  - refreshToken
```
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder refreshToken(String 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. The option is a: java.lang.String type. Group: consumer
  - basicPropertyBinding
```
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder basicPropertyBinding(boolean basicPropertyBinding)
```
    Whether the component should use basic property binding (Camel 2.x) or the newer property binding with additional capabilities. The option is a: boolean type. Default: false Group: advanced
  - clientFactory
```
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder clientFactory(org.apache.camel.component.google.mail.GoogleMailClientFactory clientFactory)
```
    The client Factory. The option is a: org.apache.camel.component.google.mail.GoogleMailClientFactory type. Group: advanced
  - configuration
```
default GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder configuration(org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration configuration)
```
    The configuration. The option is a: org.apache.camel.component.google.mail.stream.GoogleMailStreamConfiguration type. Group: advanced

Interface GoogleMailStreamComponentBuilderFactory.GoogleMailStreamComponentBuilder

Method Summary

Methods inherited from interface org.apache.camel.builder.component.ComponentBuilder

Method Detail

accessToken

applicationName

bridgeErrorHandler

clientId

clientSecret

labels

markAsRead

maxResults

query

refreshToken

basicPropertyBinding

clientFactory

configuration