Inboxes
Uma inbox é um endereço de recebimento mais as regras aplicadas ao e-mail que chega nele. Veja o modelo Inbox para o formato do objeto retornado.
| Comando | HTTP | Descrição |
|---|---|---|
inboxes list | GET /inboxes | Lista as inboxes do workspace. Paginado por cursor. |
inboxes get | GET /inboxes/{id} | Busca uma inbox por id interno ou external_id. |
inboxes create | POST /inboxes | Cria uma inbox — o endereço é composto e fica ativo imediatamente. |
inboxes upsert | PUT /inboxes | Cria ou atualiza, casado por id, external_id, depois email. |
inboxes update | PATCH /inboxes/{id} | Atualiza no local. Mudar o slug reposiciona o endereço de recebimento. |
inboxes delete | DELETE /inboxes/{id} | Soft-delete. |
inboxes recipients create | POST /inboxes/{id}/recipients | Adiciona um endereço a allowed_recipients. |
inboxes recipients delete | DELETE /inboxes/{id}/recipients | Remove um endereço de allowed_recipients. |
Exemplos
# Listar, filtrado por status
kobana inbox inboxes list \
--params '{"status": "active", "limit": 25}' \
--fields "id,label,email,status"
# Buscar uma
kobana inbox inboxes get \
--params '{"id": "INBOX_ID"}' \
--fields "id,label,email,agent_id,filters"
# Criar
kobana inbox inboxes create \
--json '{"label": "Suporte", "slug": "support", "agent_id": "AGENT_ID"}'
# Criar ou atualizar, casado por email
kobana inbox inboxes upsert \
--json '{"email": "acme.workspace.support@inbox.kobana.com.br", "agent_id": "AGENT_ID"}'
# Atualizar filtros
kobana inbox inboxes update \
--params '{"id": "INBOX_ID"}' \
--json '{"attachments_allow": false}'
# Soft-delete
kobana inbox inboxes delete --params '{"id": "INBOX_ID"}' --dry-run
# Autorizar um remetente
kobana inbox inboxes recipients create \
--params '{"id": "INBOX_ID"}' \
--json '{"email": "sender@example.com"}'
# Revogar um remetente
kobana inbox inboxes recipients delete \
--params '{"id": "INBOX_ID", "email": "sender@example.com"}'