Google Mail

Google Mail

Scheme: google-mail
Syntax: google-mail:apiName/methodName
Description: The google-mail component provides access to Google Mail.
Deprecated:false
Async:false
Maven: org.apache.camel/camel-google-mail/2.18.1.redhat-000035

The google-mail component provides access to Google Mail.

Name Kind Group Required Default Type Enum Description
apiName path common true org.apache.camel.component.google.mail.internal.GoogleMailApiName THREADS
MESSAGES
ATTACHMENTS
LABELS
HISTORY
DRAFTS
USERS
What kind of operation to perform
methodName path common true java.lang.String attachments
create
delete
get
getProfile
gmailImport
insert
list
modify
patch
send
trash
untrash
update
What sub operation to use for the selected operation
accessToken parameter common java.lang.String OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage.
applicationName parameter common java.lang.String Google mail application name. Example would be "camel-google-mail/1.0"
clientId parameter common java.lang.String Client ID of the mail application
clientSecret parameter common java.lang.String Client secret of the mail application
inBody parameter common java.lang.String Sets the name of a parameter to be passed in the exchange In Body
refreshToken parameter common java.lang.String 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.
scopes parameter common java.util.List Specifies the level of permissions you want a mail application to have to a user account. See https://developers.google.com/gmail/api/auth/scopes for more info.
bridgeErrorHandler parameter consumer boolean 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/ERROR level and ignored.
exceptionHandler parameter consumer (advanced) org.apache.camel.spi.ExceptionHandler To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored.
exchangePattern parameter consumer (advanced) org.apache.camel.ExchangePattern InOnly
RobustInOnly
InOut
InOptionalOut
OutOnly
RobustOutOnly
OutIn
OutOptionalIn
Sets the exchange pattern when the consumer creates an exchange.
synchronous parameter advanced false boolean Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported).

google-mail consumer

The GoogleMail consumer.