Saltar al contenido principal

Inboxes

Un inbox es una dirección de recepción más las reglas aplicadas al correo que llega a ella. Ver el modelo Inbox para la forma del objeto devuelto.

ComandoHTTPDescripción
inboxes listGET /inboxesLista los inboxes del workspace. Paginado por cursor.
inboxes getGET /inboxes/{id}Obtiene un inbox por id interno o external_id.
inboxes createPOST /inboxesCrea un inbox — la dirección se compone y queda activa de inmediato.
inboxes upsertPUT /inboxesCrea o actualiza, emparejado por id, external_id, luego email.
inboxes updatePATCH /inboxes/{id}Actualiza en el lugar. Cambiar el slug reubica la dirección de recepción.
inboxes deleteDELETE /inboxes/{id}Soft-delete.
inboxes recipients createPOST /inboxes/{id}/recipientsAgrega una dirección a allowed_recipients.
inboxes recipients deleteDELETE /inboxes/{id}/recipientsElimina una dirección de allowed_recipients.

Ejemplos​

# Listar, filtrado por estado
kobana inbox inboxes list \
--params '{"status": "active", "limit": 25}' \
--fields "id,label,email,status"

# Obtener uno
kobana inbox inboxes get \
--params '{"id": "INBOX_ID"}' \
--fields "id,label,email,agent_id,filters"

# Crear
kobana inbox inboxes create \
--json '{"label": "Soporte", "slug": "support", "agent_id": "AGENT_ID"}'

# Crear o actualizar, emparejado por email
kobana inbox inboxes upsert \
--json '{"email": "acme.workspace.support@inbox.kobana.com.br", "agent_id": "AGENT_ID"}'

# Actualizar 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 un remitente
kobana inbox inboxes recipients create \
--params '{"id": "INBOX_ID"}' \
--json '{"email": "sender@example.com"}'

# Revocar un remitente
kobana inbox inboxes recipients delete \
--params '{"id": "INBOX_ID", "email": "sender@example.com"}'

Próximos pasos​

  • Correos — los mensajes que llegan a un inbox.
  • Agents — el procesador al que apunta un inbox.