Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions apps/docs/providers/communications/agentmail.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,16 +11,17 @@ provider.
Roomote can receive email sent to a dedicated deployment inbox, start tasks
from those messages, and reply in the same email thread. AgentMail delivers
inbound mail through a `message.received` webhook, so Roomote must be reachable
at a stable public HTTPS URL. Each deployment brings its own AgentMail account
and API key.
at a stable public HTTPS URL. Self-hosted deployments bring their own AgentMail
account and API key; Roomote Cloud provisions managed credentials.

## Enable the email channel

Email is off by default. Set `R_EMAIL_CHANNEL_ENABLED=true` in the
deployment's environment and restart. Until then the provider does not
appear in settings, inbound webhook deliveries are acknowledged and dropped,
and Roomote never sends email. On Roomote Cloud this is enabled per
deployment by the Roomote team.
and Roomote never sends email. New Roomote Cloud deployments receive a managed
`<workspace-slug>@roomote.me` inbox by default; older deployments remain
disabled until Roomote enables them.

Enabling the channel gives the deployment an email sender for the first
time, so new password sign-ups also receive a verification email (see
Expand All @@ -44,6 +45,11 @@ then:
3. In the Roomote UI (**Settings > Communications > Email (AgentMail)**),
paste the key and save.

Roomote Cloud manages these credentials and the webhook. Its Communications
settings show the inbox and connection status without exposing setup, removal,
or repair controls. The configuration steps below apply to self-hosted
deployments.

Roomote uses the inbox the key is scoped to; there is nothing else to enter.
On save it validates the key, registers a webhook on the inbox for
`message.received`, `message.bounced`, and `message.complained` events, and
Expand Down
128 changes: 126 additions & 2 deletions apps/web/src/components/settings/CommsProviderSection.test.tsx

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading