diff --git a/Home.md b/Home.md index 93a012c..5cba25b 100644 --- a/Home.md +++ b/Home.md @@ -1,21 +1,40 @@ -# Deploy the Project on CamelX Platform +# Mail IMAP Source -Deploy on CamelX Platform in three steps +Receive unread emails from an IMAP mail server, marking them as read once they are received. -## Step 1: Create a release -From the project space, click on **"Create a release"** +The Kamelet generates the following headers: -The new version is automatically available in the list +- `subject` / `ce-subject`: the subject of the incoming mail -## Step 2: Deploy -Click on **"Deploy"** +- `from` / `ce-from`: the `from` field of the incoming mail -- **Version:** Select the desired release -- **Environment:** Choose `Development`, `Staging`, or `Production` -- **Configuration:** Select the configuration source -- **Resources:** Set CPU and Memory +- `to` / `ce-to`: the `to` field of the incoming mail -## Step 3: Expose -Enable **"Expose"** +- `cc` / `ce-cc`: the `cc` field of the incoming mail -Choose an **API Gateway** (Internal, Public, etc.) +## Metadata + +| Property | Value | +|----------|-------| +| Type | source | +| Group | Mail | +| Namespace | Mail | +| Support Level | Stable | +| Provider | Apache Software Foundation | + +## Properties + +| Name | Type | Required | Default | Description | +|------|------|----------|---------|-------------| +| `connectionHost` | string | ✓ | | The IMAP server host | +| `connectionPort` | string | ✓ | `993` | The IMAP server port | +| `username` | string | ✓ | | The username to access the mail box | +| `password` | string | ✓ | | The password to access the mail box | +| `fetchSize` | integer | | `10` | The number of messages fetched for each poll (-1 for no limits) | +| `delay` | integer | | `60000` | The delay between fetches in milliseconds | + +## Dependencies + +- `camel:core` +- `camel:mail` +- `camel:kamelet`