Desk

File a message that arrived as a conversation

Turns one message out of a connected mailbox into the two records the product acts on: the conversation it belongs to, and the message itself. Threading follows the mail headers first and the normalised subject second, so "Re: Re: Fw: Leak" and "Leak" are one conversation.

Nobody is created. A sender the address book does not hold stays an address on the message rather than becoming a contact behind your back.

Filing is idempotent on uid: the same message sent twice answers with the records it already has and filed: false.

post/api/v1/handling/intake

Request

  • Base URL: http://localhost:5180
  • URL: http://localhost:5180/api/v1/handling/intake
  • Auth: API key in cookie better-auth.session_token

Request body

uidstring required

The provider’s id for the message, which is what stops a re-sync filing it twice.

messageIdstring

RFC 822 Message-ID, which is what actually threads mail.

inReplyTostring
referencesstring[]
forwardedBystring

The mailbox that forwarded this here on its own. A reply copies it and names it as Reply-To.

subjectstring required
receivedAtstring

When it arrived. Now, where the caller does not say.

bodystring required

Plain text. An HTML-only message is flattened by whatever read the mailbox.

Response

The conversation and the message it was filed as.

okunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.