Skip to main content

E-mails

The messages that arrived on your inboxes, their parsed content and their processing state. See the Email model for the received → approved | rejected → processing → processed | failed state machine.

CommandHTTPDescription
emails listGET /emailsList received e-mails. Bodies are not included.
emails getGET /emails/{id}Fetch one e-mail, including parsed text and HTML bodies.
emails emlGET /emails/{id}/emlGet a short-lived presigned URL for the original .eml — expires in 60 seconds.
emails reprocessPOST /emails/{id}/reprocessRe-enqueue an e-mail for its agent. Only from approved, processed or failed.
emails deleteDELETE /emails/{id}Soft-delete.

Examples​

# List, filtered by status and inbox
kobana inbox emails list \
--params '{"status": "processed", "inbox_id": "INBOX_ID", "limit": 25}' \
--fields "id,subject,from,status,received_at"

# Get one, with bodies
kobana inbox emails get \
--params '{"id": "EMAIL_ID"}' \
--fields "id,subject,text_body,status"

# Get the presigned .eml URL and save the response
kobana inbox emails eml \
--params '{"id": "EMAIL_ID"}' \
--output eml-url.json

# Reprocess with a different agent
kobana inbox emails reprocess \
--params '{"id": "EMAIL_ID"}' \
--json '{"agent_id": "AGENT_ID"}'

# Soft-delete
kobana inbox emails delete --params '{"id": "EMAIL_ID"}' --dry-run

Next steps​

  • Agents — the processor that ran over an e-mail.
  • System events — the event trail an e-mail produced.