fyi.filed.prosebox.letter Documentation (EN)

main record

A correspondence letter.

Record Key tid Timestamp-based ID

Properties

body string Required

Letter body in the CommonMark subset defined by the ATProsebox presentation contract.

maxLength: 100000 bytes

box string did Required

DID of the recipient. Delivery is indexing: an inbox is letters whose box is one's own DID.

maxLength: 2048 bytes

createdAt string datetime Required

An RFC 3339 formatted timestamp.

deliverAt string datetime Optional

Optional delayed-arrival timestamp. Renderers should not display the letter in the recipient's inbox before this time.

replyTo string at-uri Optional

AT-URI of the letter this one replies to.

maxLength: 8192 bytes

subject string Optional

No description available.

maxLength: 640 bytesmaxGraphemes: 256 graphemes

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "box",
      "body",
      "createdAt"
    ],
    "properties": {
      "box": {
        "type": "string",
        "format": "did",
        "maxLength": 2048,
        "description": "DID of the recipient. Delivery is indexing: an inbox is letters whose box is one's own DID."
      },
      "body": {
        "type": "string",
        "maxLength": 100000,
        "description": "Letter body in the CommonMark subset defined by the ATProsebox presentation contract."
      },
      "replyTo": {
        "type": "string",
        "format": "at-uri",
        "maxLength": 8192,
        "description": "AT-URI of the letter this one replies to."
      },
      "subject": {
        "type": "string",
        "maxLength": 640,
        "maxGraphemes": 256
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "deliverAt": {
        "type": "string",
        "format": "datetime",
        "description": "Optional delayed-arrival timestamp. Renderers should not display the letter in the recipient's inbox before this time."
      }
    }
  },
  "description": "A correspondence letter."
}