camel.apache.org/google-mail-stream
1
0
Fork 0
generated from camel.apache.org/component
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update wiki Home page for google-mail-stream

gitea_admin 2026-03-11 14:38:22 +00:00
parent 5349156e5e
commit aa0f75fe9b
1 changed files with 53 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

67
Home.md

@ -1,21 +1,60 @@
# Deploy the Project on CamelX Platform
# Google Mail Stream
Deploy on CamelX Platform in three steps
Poll for incoming messages in Google Mail.
## Step 1: Create a release
From the project space, click on **"Create a release"**
## Metadata
The new version is automatically available in the list
| Property | Value |
|----------|-------|
| Scheme | `google-mail-stream` |
| Support Level | Stable |
| Labels | cloud,mail |
| Version | 4.10.2 |
## Step 2: Deploy
Click on **"Deploy"**
## Maven Dependency
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
```xml
<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-google-mail</artifactId>
<version>4.10.2</version>
</dependency>
```
## Step 3: Expose
Enable **"Expose"**
## Endpoint Properties
Choose an **API Gateway** (Internal, Public, etc.)
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `index` | string | ✓ | | Currently not in use |
| `applicationName` | string | | | Google mail application name. Example would be camel-google-mail/1.0 |
| `clientId` | string | | | Client ID of the mail application |
| `delegate` | string | | | Delegate for wide-domain service account |
| `labels` | string | | | Comma separated list of labels to take into account |
| `markAsRead` | boolean | | `true` | Mark the message as read once it has been consumed |
| `maxResults` | integer | | `10` | Max results to be returned |
| `query` | string | | `is:unread` | The query to execute on gmail box |
| `raw` | boolean | | `false` | Whether to store the entire email message in an RFC 2822 formatted and base64url encoded string (in JSon format), in the Camel message body. |
| `scopes` | array | | | GMail scopes |
| `sendEmptyMessageWhenIdle` | boolean | | `false` | If the polling consumer did not poll any files, you can enable this option to send an empty message (no body) instead. |
| `bridgeErrorHandler` | boolean | | `false` | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. 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. |
| `exceptionHandler` | object | | | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored. |
| `exchangePattern` | object | | | Sets the exchange pattern when the consumer creates an exchange. |
| `pollStrategy` | object | | | A pluggable org.apache.camel.PollingConsumerPollingStrategy allowing you to provide your custom implementation to control error handling usually occurred during the poll operation before an Exchange have been created and being routed in Camel. |
| `backoffErrorThreshold` | integer | | | The number of subsequent error polls (failed due some error) that should happen before the backoffMultipler should kick-in. |
| `backoffIdleThreshold` | integer | | | The number of subsequent idle polls that should happen before the backoffMultipler should kick-in. |
| `backoffMultiplier` | integer | | | To let the scheduled polling consumer backoff if there has been a number of subsequent idles/errors in a row. The multiplier is then the number of polls that will be skipped before the next actual attempt is happening again. When this option is in use then backoffIdleThreshold and/or backoffErrorThreshold must also be configured. |
| `delay` | integer | | `500` | Milliseconds before the next poll. |
| `greedy` | boolean | | `false` | If greedy is enabled, then the ScheduledPollConsumer will run immediately again, if the previous run polled 1 or more messages. |
| `initialDelay` | integer | | `1000` | Milliseconds before the first poll starts. |
| `repeatCount` | integer | | `0` | Specifies a maximum limit of number of fires. So if you set it to 1, the scheduler will only fire once. If you set it to 5, it will only fire five times. A value of zero or negative means fire forever. |
| `runLoggingLevel` | object | | `TRACE` | The consumer logs a start/complete log line when it polls. This option allows you to configure the logging level for that. |
| `scheduledExecutorService` | object | | | Allows for configuring a custom/shared thread pool to use for the consumer. By default each consumer has its own single threaded thread pool. |
| `scheduler` | object | | `none` | To use a cron scheduler from either camel-spring or camel-quartz component. Use value spring or quartz for built in scheduler |
| `schedulerProperties` | object | | | To configure additional properties when using a custom scheduler or any of the Quartz, Spring based scheduler. |
| `startScheduler` | boolean | | `true` | Whether the scheduler should be auto started. |
| `timeUnit` | object | | `MILLISECONDS` | Time unit for initialDelay and delay options. |
| `useFixedDelay` | boolean | | `true` | Controls if fixed delay or fixed rate is used. See ScheduledExecutorService in JDK for details. |
| `accessToken` | string | | | OAuth 2 access token. This typically expires after an hour so refreshToken is recommended for long term usage. |
| `clientSecret` | string | | | Client secret of the mail application |
| `refreshToken` | 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. |
| `serviceAccountKey` | string | | | Sets .json file with credentials for Service account |