Update wiki Home page for google-mail-source

gitea_admin 2026-03-11 14:36:34 +00:00
parent a26a844064
commit a30a7d3f52

41
Home.md

@ -1,21 +1,34 @@
# Deploy the Project on CamelX Platform
# Google Mail Source
Deploy on CamelX Platform in three steps
Receive data from 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 |
|----------|-------|
| Type | source |
| Group | Google Mail |
| Namespace | GCP |
| Support Level | Stable |
| Provider | Apache Software Foundation |
## Step 2: Deploy
Click on **"Deploy"**
## Properties
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `index` | string | ✓ | | An index for the google mail endpoint |
| `clientId` | string | ✓ | | Client ID of the gmail application |
| `clientSecret` | string | ✓ | | Client Secret of the gmail application |
| `accessToken` | string | ✓ | | OAuth 2 access token for google mail application. This typically expires after an hour so refreshToken is recommended for long term usage. |
| `refreshToken` | string | ✓ | | OAuth 2 refresh token for google mail application. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. |
| `delay` | integer | | `500` | The number of milliseconds before the next poll |
| `applicationName` | string | ✓ | | Google Mail application name |
| `markAsRead` | boolean | | `true` | Mark the message as read once it has been consumed |
| `labels` | string | | | Comma separated list of labels to take into account |
| `query` | string | | `is:unread` | The query to execute on gmail box |
## Step 3: Expose
Enable **"Expose"**
## Dependencies
Choose an **API Gateway** (Internal, Public, etc.)
- `camel:jackson`
- `camel:kamelet`
- `camel:google-mail`