volanea_create_inbox
Create an email inbox an agent can receive mail at (private beta — answers inboxes_not_enabled if the project isn't in it). Omit domain for an address on the shared domain, usable immediately. Pass a clientId (e.g. your agent's name) so calling this again returns the same inbox instead of making another — addresses are permanent and never recycled. Then wait for mail with volanea_wait_for_email and read conversations with volanea_read_inbox. This server never sends from an inbox; replies go through POST /v1/inboxes/{inboxId}/messages/{emailId}/reply in the user's code.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| domain | No | A verified domain of the project whose MX points at SES (use a subdomain like agents.company.com). Omit for the shared domain. | |
| clientId | No | Idempotency key. Strongly recommended. | |
| username | No | Local part of the address. Random if omitted. | |
| displayName | No | From name on mail sent from this inbox. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | Machine-readable failure code to branch on. Present only when success is false. | |
| data | No | Present when success is true. | |
| error | No | Human-readable failure reason. Present only when success is false. | |
| success | Yes | False when the call failed; read `error` and `code` in that case. |