Inboxes
An inbox is a receiving address plus the rules applied to the mail that arrives on it. See the Inbox model for the shape of the returned object.
| Command | HTTP | Description |
|---|---|---|
inboxes list | GET /inboxes | List inboxes in the workspace. Cursor-paginated. |
inboxes get | GET /inboxes/{id} | Fetch one inbox by internal id or external_id. |
inboxes create | POST /inboxes | Create an inbox — the address is composed and live immediately. |
inboxes upsert | PUT /inboxes | Create or update, matched by id, external_id, then email. |
inboxes update | PATCH /inboxes/{id} | Update in place. Changing slug repoints the receiving address. |
inboxes delete | DELETE /inboxes/{id} | Soft-delete. |
inboxes recipients create | POST /inboxes/{id}/recipients | Add one address to allowed_recipients. |
inboxes recipients delete | DELETE /inboxes/{id}/recipients | Remove one address from allowed_recipients. |
Examples
# List, filtered by status
kobana inbox inboxes list \
--params '{"status": "active", "limit": 25}' \
--fields "id,label,email,status"
# Get one
kobana inbox inboxes get \
--params '{"id": "INBOX_ID"}' \
--fields "id,label,email,agent_id,filters"
# Create
kobana inbox inboxes create \
--json '{"label": "Support", "slug": "support", "agent_id": "AGENT_ID"}'
# Create or update, matched by email
kobana inbox inboxes upsert \
--json '{"email": "acme.workspace.support@inbox.kobana.com.br", "agent_id": "AGENT_ID"}'
# Update filters
kobana inbox inboxes update \
--params '{"id": "INBOX_ID"}' \
--json '{"attachments_allow": false}'
# Soft-delete
kobana inbox inboxes delete --params '{"id": "INBOX_ID"}' --dry-run
# Allow a sender
kobana inbox inboxes recipients create \
--params '{"id": "INBOX_ID"}' \
--json '{"email": "sender@example.com"}'
# Revoke a sender
kobana inbox inboxes recipients delete \
--params '{"id": "INBOX_ID", "email": "sender@example.com"}'