Email: Accounts
Catalog id: resource.email.accounts
Named SMTP (or product transport) senders for this tenant: From identity, host, credentials, TLS options. Routing assigns message types to these accounts. Product flows never send without resolving an account.
Guide: Branding and email.
Open it
| Navigation | Resources > Email > Accounts |
| Deep link | #resource=email&rarea=accounts |
| Scope | Tenant |
List columns
| Column | Content |
|---|---|
| Account | Display name, account id, Local default badge when applicable |
| Sender | From name and from address |
| SMTP server | Host:port |
| Credentials | Whether a password reference is set (secret never shown) |
| Mode | Management mode (for example EXTERNAL) |
| Status | Lifecycle (Active when enabled) |
Row actions
| Action | Effect |
|---|---|
| Send test | Dialog: recipient, subject, body; submits through this account only |
| Edit | Reload latest config; update From, SMTP, password (blank keeps existing) |
| Make default | Sets tenant local default for types without a purpose assignment |
| Delete | Blocked if account is local default or still assigned to a purpose route |
Create fields
| Field | Notes |
|---|---|
| Account ID | Stable id for routing; immutable after create |
| Display name | Operator label |
| From address / From name | Recipient-visible sender |
| Reply-to | Optional |
| SMTP host, port | Submission endpoint |
| Username, SMTP password | Auth; password write-only after save |
| STARTTLS / implicit SSL | Match provider (587 vs 465) |
| Connection / read timeout (ms) | Fail-fast on dead relays |
REST
- Overview
- Request
- Response
List email accounts
Endpoint: GET /api/platform/config/v1/tenants/acme/email/accounts
Captured response: 200 OK
This captured endpoint is shown from the E2E run; it is not mapped to one of the generated EDK REST API reference pages.
Connect an environment to rewrite this call to real service bases and run it.
- Overview
- Request
- Response
Create email account
Endpoint: POST /api/platform/config/v1/tenants/acme/email/accounts
Captured response: 201 Created
This captured endpoint is shown from the E2E run; it is not mapped to one of the generated EDK REST API reference pages.
Connect an environment to rewrite this call to real service bases and run it.
Platform config API. Guide: Branding and email.