{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":["json-schema"]},"type":"markdown"},"seo":{"title":"Message envelope","description":"Developer documentation for integrating systems that send messages, plus reporting and operational APIs for platform holders."},"dynamicMarkdocComponents":["openapi"],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"message-envelope","__idx":0},"children":["Message envelope"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"this-should-be-reviewed-by-a-developer-or-architect","__idx":1},"children":["This should be reviewed by a developer or architect"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An envelope is the structural framework for delivering a digital message through the Digital"," ","Post Platform (DPP). It contains essential details, such as sender and recipient information,"," ","message metadata, and specific instructions governing message features and interactions."," ","Designed for secure and organized message handling, the envelope acts as a wrapper around"," ","the content, enabling consistent communication across the DPP."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"envelope-components","__idx":2},"children":["Envelope Components"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Recipients"]},": Defines who will receive the message. Each message requires at least one recipient"," ","and allows up to ten. Recipients are identified by values provided by authorized identity"," ","providers."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Sender"]},": Specifies the originator of the message, visible to recipients. It also determines"," ","available features, depending on permissions set on the Sender."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message Content"]},": References to files that will be delivered as the body of the message or"," ","attached to the message."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Message Features"]},": Includes additional functionalities, such as:",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scheduled Delivery"]},": Postpones delivery to a scheduled time."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Interim message"]},": Holds messages for recipients without an account, to be delivered when"," ","they join the platform."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Open Receipt"]},": Registers a receipt when recipients access the message."]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"envelope-schema","__idx":3},"children":["envelope schema"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/assets/envelope-schema_1.0.2.6db0c2fce8721fa4233908d680497214b3c47a500e07f317ee6d23d7f5cd31c4.de6e0f62.json"},"children":["envelope-schema_1.0.2.json"]}]},{"$$mdtype":"Tag","name":"JsonSchema","attributes":{"schema":{"$ref":"../static/envelope-schema_1.0.2.json"},"options":{},"schemaResolved":{"openapi":"3.1.0","components":{"schemas":{"__root":{"$ref":"#/components/schemas/envelope-schema_1.0.2"},"mediaType":{"type":"string","enum":["application/pdf","application/msword","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.ms-excel","application/vnd.ms-powerpoint","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.oasis.opendocument.presentation","application/vnd.oasis.opendocument.spreadsheet","application/vnd.oasis.opendocument.text","application/rtf","text/html","text/plain","text/rtf","image/png","image/jpeg","image/bmp","image/gif","image/tiff"]},"filename":{"type":"string","maxLength":101,"pattern":"^[0-9a-zA-Z_\\-. ]+\\.(pdf|doc|docx|xls|ppt|xlsx|pptx|odp|ods|odt|rtf|html|htm|txt|png|jpeg|jpg|bmp|gif|tiff|tif)$"},"email":{"type":"string","format":"email"},"interim":{"description":"Configuration for interim message handling when a recipient does not have an active mailbox.","type":"object","required":["enable"],"additionalProperties":false,"properties":{"enable":{"description":"Indicates whether interim messaging is enabled for this recipient.","type":"boolean"},"notificationEmail":{"description":"Email address to notify when a message is placed in the interim repository.","$ref":"#/components/schemas/email"}}},"file":{"description":"References a file in object storage, with metadata used for validation and recipient display.","type":"object","required":["name","mimeType","filename"],"additionalProperties":false,"properties":{"name":{"description":"Object key or internal file name referenced by the envelope.","type":"string","maxLength":101},"title":{"description":"Display title of the file shown to recipients.","type":"string","maxLength":101},"hash":{"description":"Hash value of the file for integrity verification.","type":"string"},"mimeType":{"description":"Media type of the referenced file.","$ref":"#/components/schemas/mediaType"},"filename":{"description":"The full file name presented to recipients, including the file extension.","$ref":"#/components/schemas/filename"}}},"datetime":{"description":"RFC 3339 date-time string.","type":"string","format":"date-time"},"userRecipient":{"description":"Represents a recipient of the message.","type":"object","required":["identity"],"additionalProperties":false,"properties":{"identity":{"description":"Key-value identity attributes used to resolve the recipient. Exactly one key-value pair is required.","type":"object","minProperties":1,"maxProperties":1,"propertyNames":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z0-9/\\._-]{1,30}$"},"additionalProperties":{"type":"string","minLength":1}},"interim":{"description":"Interim message handling configuration for this recipient.","$ref":"#/components/schemas/interim"}}},"batchSender":{"description":"Specifies the sender organization and optional user context.","type":"object","required":["organizationId","senderId"],"additionalProperties":false,"properties":{"userId":{"description":"Identifier of the user sending the message.","type":"integer","format":"int64","minimum":2},"senderId":{"description":"Identifier of the sender.","type":"integer","format":"int64","minimum":1},"organizationId":{"description":"Identifier of the sender's organization.","type":"integer","format":"int64","minimum":2}}},"envelope-schema_1.0.2":{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"envelope-schema_1.0.2.json","title":"Envelope","description":"Defines a message envelope that specifies sender, recipients, referenced files, and optional message features.","type":"object","required":["body","messageId","recipients","sender","title"],"additionalProperties":false,"properties":{"attachments":{"description":"List of attachments included in the message.","type":"array","maxItems":20,"items":{"$ref":"#/components/schemas/file"}},"body":{"description":"Main message body file.","$ref":"#/components/schemas/file"},"deliverAt":{"description":"Scheduled delivery timestamp in RFC 3339 format. The message is processed immediately, but delivery is deferred until this time.","$ref":"#/components/schemas/datetime"},"messageId":{"description":"Unique identifier for the message within the sender organization.","type":"string","maxLength":71,"pattern":"^[a-zA-Z0-9/\\\\._-]+$"},"recipients":{"description":"List of message recipients.","type":"array","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/userRecipient"}},"requireOpenReceipt":{"description":"If true, an open receipt must be registered before the recipient can access the message content. Only supported for single recipient envelopes.","type":"boolean","default":false},"sender":{"description":"Details of the message sender, used for recipient display and feature authorization.","$ref":"#/components/schemas/batchSender"},"title":{"description":"Title of the message shown to recipients. Do not include sensitive data.","type":"string","maxLength":101}},"$defs":{"file":{"description":"References a file in object storage, with metadata used for validation and recipient display.","type":"object","required":["name","mimeType","filename"],"additionalProperties":false,"properties":{"name":{"description":"Object key or internal file name referenced by the envelope.","type":"string","maxLength":101},"title":{"description":"Display title of the file shown to recipients.","type":"string","maxLength":101},"hash":{"description":"Hash value of the file for integrity verification.","type":"string"},"mimeType":{"description":"Media type of the referenced file.","$ref":"#/components/schemas/mediaType"},"filename":{"description":"The full file name presented to recipients, including the file extension.","$ref":"#/components/schemas/filename"}}},"userRecipient":{"description":"Represents a recipient of the message.","type":"object","required":["identity"],"additionalProperties":false,"properties":{"identity":{"description":"Key-value identity attributes used to resolve the recipient. Exactly one key-value pair is required.","type":"object","minProperties":1,"maxProperties":1,"propertyNames":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z0-9/\\._-]{1,30}$"},"additionalProperties":{"type":"string","minLength":1}},"interim":{"description":"Interim message handling configuration for this recipient.","$ref":"#/components/schemas/interim"}}},"interim":{"description":"Configuration for interim message handling when a recipient does not have an active mailbox.","type":"object","required":["enable"],"additionalProperties":false,"properties":{"enable":{"description":"Indicates whether interim messaging is enabled for this recipient.","type":"boolean"},"notificationEmail":{"description":"Email address to notify when a message is placed in the interim repository.","$ref":"#/components/schemas/email"}}},"batchSender":{"description":"Specifies the sender organization and optional user context.","type":"object","required":["organizationId","senderId"],"additionalProperties":false,"properties":{"userId":{"description":"Identifier of the user sending the message.","type":"integer","format":"int64","minimum":2},"senderId":{"description":"Identifier of the sender.","type":"integer","format":"int64","minimum":1},"organizationId":{"description":"Identifier of the sender's organization.","type":"integer","format":"int64","minimum":2}}},"datetime":{"description":"RFC 3339 date-time string.","type":"string","format":"date-time"},"email":{"type":"string","format":"email"},"mediaType":{"type":"string","enum":["application/pdf","application/msword","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.ms-excel","application/vnd.ms-powerpoint","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.oasis.opendocument.presentation","application/vnd.oasis.opendocument.spreadsheet","application/vnd.oasis.opendocument.text","application/rtf","text/html","text/plain","text/rtf","image/png","image/jpeg","image/bmp","image/gif","image/tiff"]},"filename":{"type":"string","maxLength":101,"pattern":"^[0-9a-zA-Z_\\-. ]+\\.(pdf|doc|docx|xls|ppt|xlsx|pptx|odp|ods|odt|rtf|html|htm|txt|png|jpeg|jpg|bmp|gif|tiff|tif)$"}}}}}},"schemaResolvedErrors":[]},"children":[]}]},"headings":[{"value":"Message envelope","id":"message-envelope","depth":1},{"value":"This should be reviewed by a developer or architect","id":"this-should-be-reviewed-by-a-developer-or-architect","depth":2},{"value":"Envelope Components","id":"envelope-components","depth":2},{"value":"envelope schema","id":"envelope-schema","depth":2}],"frontmatter":{"seo":{"title":"Message envelope"}},"lastModified":"2026-05-19T07:20:06.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/documentation/message-envelope","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}