Package org.apache.camel.builder.endpoint.dsl

Interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder

All Superinterfaces:

org.apache.camel.builder.EndpointConsumerBuilder, org.apache.camel.EndpointConsumerResolver, org.apache.camel.builder.EndpointProducerBuilder, org.apache.camel.EndpointProducerResolver, GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder, GoogleMailEndpointBuilderFactory.GoogleMailEndpointProducerBuilder

Enclosing interface:

GoogleMailEndpointBuilderFactory

public static interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder
extends GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder, GoogleMailEndpointBuilderFactory.GoogleMailEndpointProducerBuilder

Builder for endpoint for the Google Mail component.

Method Summary

Modifier and Type	Method	Description
default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder	accessToken(String accessToken)	OAuth 2 access token.
default GoogleMailEndpointBuilderFactory.AdvancedGoogleMailEndpointBuilder	advanced()
default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder	applicationName(String applicationName)	Google mail application name.
default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder	clientId(String clientId)	Client ID of the mail application.
default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder	clientSecret(String clientSecret)	Client secret of the mail application.
default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder	delegate(String delegate)	Delegate for wide-domain service account.
default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder	inBody(String inBody)	Sets the name of a parameter to be passed in the exchange In Body.
default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder	refreshToken(String refreshToken)	OAuth 2 refresh token.
default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder	scopes(String scopes)	GMail scopes.
default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder	scopes(Collection<String> scopes)	GMail scopes.
default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder	serviceAccountKey(String serviceAccountKey)	Service account key in json format to authenticate an application as a service account.

Methods inherited from interface org.apache.camel.builder.EndpointConsumerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointConsumerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.EndpointProducerBuilder

doSetMultiValueProperties, doSetMultiValueProperty, doSetProperty, expr, getRawUri, getUri

Methods inherited from interface org.apache.camel.EndpointProducerResolver

resolve, resolve

Methods inherited from interface org.apache.camel.builder.endpoint.dsl.GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder

backoffErrorThreshold, backoffErrorThreshold, backoffIdleThreshold, backoffIdleThreshold, backoffMultiplier, backoffMultiplier, delay, delay, greedy, greedy, initialDelay, initialDelay, repeatCount, repeatCount, runLoggingLevel, runLoggingLevel, scheduledExecutorService, scheduledExecutorService, scheduler, scheduler, schedulerProperties, schedulerProperties, sendEmptyMessageWhenIdle, sendEmptyMessageWhenIdle, startScheduler, startScheduler, timeUnit, timeUnit, useFixedDelay, useFixedDelay

Method Details

advanced

default GoogleMailEndpointBuilderFactory.AdvancedGoogleMailEndpointBuilder advanced()

Specified by:

advanced in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder

Specified by:

advanced in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointProducerBuilder

applicationName

default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder applicationName(String applicationName)

Google mail application name. Example would be camel-google-mail/1.0. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

applicationName in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder

Specified by:

applicationName in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointProducerBuilder

Parameters:

applicationName - the value to set

Returns:

the dsl builder

clientId

default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder clientId(String clientId)

Client ID of the mail application. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

clientId in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder

Specified by:

clientId in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointProducerBuilder

Parameters:

clientId - the value to set

Returns:

the dsl builder

delegate

default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder delegate(String delegate)

Delegate for wide-domain service account. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

delegate in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder

Specified by:

delegate in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointProducerBuilder

Parameters:

delegate - the value to set

Returns:

the dsl builder

inBody

default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder inBody(String inBody)

Sets the name of a parameter to be passed in the exchange In Body. The option is a: <code>java.lang.String</code> type. Group: common

Specified by:

inBody in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder

Specified by:

inBody in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointProducerBuilder

Parameters:

inBody - the value to set

Returns:

the dsl builder

scopes

default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder scopes(Collection<String> scopes)

GMail scopes. The option is a: <code>java.util.Collection&lt;java.lang.String&gt;</code> type. Group: common

Specified by:

scopes in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder

Specified by:

scopes in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointProducerBuilder

Parameters:

scopes - the value to set

Returns:

the dsl builder

scopes

default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder scopes(String scopes)

GMail scopes. The option will be converted to a <code>java.util.Collection&lt;java.lang.String&gt;</code> type. Group: common

Specified by:

scopes in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder

Specified by:

scopes in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointProducerBuilder

Parameters:

scopes - the value to set

Returns:

the dsl builder

accessToken

default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder 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: <code>java.lang.String</code> type. Group: security

Specified by:

accessToken in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder

Specified by:

accessToken in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointProducerBuilder

Parameters:

accessToken - the value to set

Returns:

the dsl builder

clientSecret

default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder clientSecret(String clientSecret)

Client secret of the mail application. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

clientSecret in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder

Specified by:

clientSecret in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointProducerBuilder

Parameters:

clientSecret - the value to set

Returns:

the dsl builder

refreshToken

default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder 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: <code>java.lang.String</code> type. Group: security

Specified by:

refreshToken in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder

Specified by:

refreshToken in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointProducerBuilder

Parameters:

refreshToken - the value to set

Returns:

the dsl builder

serviceAccountKey

default GoogleMailEndpointBuilderFactory.GoogleMailEndpointBuilder serviceAccountKey(String serviceAccountKey)

Service account key in json format to authenticate an application as a service account. Accept base64 adding the prefix base64:. The option is a: <code>java.lang.String</code> type. Group: security

Specified by:

serviceAccountKey in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointConsumerBuilder

Specified by:

serviceAccountKey in interface GoogleMailEndpointBuilderFactory.GoogleMailEndpointProducerBuilder

Parameters:

serviceAccountKey - the value to set

Returns:

the dsl builder