{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Glossary","description":"Developer documentation for integrating systems that send messages, plus reporting and operational APIs for platform holders."},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"glossary","__idx":0},"children":["Glossary"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This glossary defines key terms used throughout the Digital Post Platform documentation."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delivery","__idx":1},"children":["Delivery"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A delivery is a submission request created using the Delivery API."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A delivery:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Contains one or more envelopes"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["References files stored in object storage"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Is processed asynchronously"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Produces a delivery report"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each delivery is identified by a unique ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["deliveryId"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"envelope","__idx":2},"children":["Envelope"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An envelope is a JSON document that defines a single message."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An envelope contains:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Sender identity"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["One or more recipients"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Message body reference"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Optional attachments"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Optional message features"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Delivery is atomic per envelope."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"message","__idx":3},"children":["Message"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A message is the logical communication unit delivered to recipients."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In the platform model:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["One envelope equals one message"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A message may include a body and attachments"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A message may be delivered to multiple recipients"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"sender-identity","__idx":4},"children":["Sender Identity"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A sender identity represents a logical communication identity within an organisation account."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It defines:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Display name and branding"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Message capabilities"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Subscription scope"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each envelope references exactly one sender identity."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"organisation-account","__idx":5},"children":["Organisation Account"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An organisation account represents a legal or operational entity participating in the platform."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Belongs to a platform holder"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Contains sender identities"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Contains system integrations"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"platform-holder","__idx":6},"children":["Platform Holder"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The platform holder governs a specific deployment of the platform."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Responsibilities include:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Platform configuration"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Organisation onboarding"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Policy enforcement"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Operational governance"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"receiver","__idx":7},"children":["Receiver"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A receiver is the end user or organisation that receives messages."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Receivers:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Are external to organisation accounts"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Are resolved during delivery processing"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access messages through a mailbox"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"recipient","__idx":8},"children":["Recipient"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A recipient is the envelope-level reference to a receiver."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Recipients are defined using an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["identification"]}," object and must resolve to a valid mailbox."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["If any recipient fails resolution, the entire envelope fails."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"identity","__idx":9},"children":["Identity"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["An identity is an attribute used to resolve a recipient."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It consists of:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["value"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["type"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Identity types are defined per platform configuration."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"system-integration","__idx":10},"children":["System Integration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A system integration is a technical client that interacts with the platform APIs."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Belongs to an organisation account"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Uses certificate-based authentication"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Has assigned permissions"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["All API calls execute in the context of a system integration."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delivery-report","__idx":11},"children":["Delivery Report"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A delivery report provides status and processing results for a delivery."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It contains:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Overall delivery status"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Envelope-level log entries"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Delivery counters"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Delivery reports are the authoritative source of delivery outcomes."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"atomic-delivery","__idx":12},"children":["Atomic Delivery"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Atomic delivery means that all recipients of an envelope receive the message, or none do."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Partial delivery is not permitted."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"interim-repository","__idx":13},"children":["Interim Repository"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The interim repository temporarily stores messages for recipients without an active mailbox."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Delivery completes once the recipient activates their account, subject to platform policy."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"message-lifecycle","__idx":14},"children":["Message Lifecycle"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The message lifecycle describes the stages a message progresses through:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Preparation → Submission → Validation → Processing → Delivery → Access → Retention → Deletion"]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"client-side-encryption","__idx":15},"children":["Client-Side Encryption"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Client-side encryption refers to encrypting message files before upload to object storage."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The encryption key is provided in the delivery request."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"processing","__idx":16},"children":["Processing"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Processing refers to asynchronous handling after delivery creation."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Processing includes:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Envelope validation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["File ingestion"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Virus scanning"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Recipient resolution"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Message preparation"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"delivery-status","__idx":17},"children":["Delivery Status"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The overall state of a delivery."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Possible values:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Processing"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Completed"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Envelope-level details are available through the delivery report."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"message-identifier--messageid-","__idx":18},"children":["Message Identifier (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["messageId"]},")"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A unique identifier for a message within a sender identity."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["It:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Must be unique"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Cannot be reused after successful delivery"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enables traceability"]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"object-storage","__idx":19},"children":["Object Storage"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["External storage used for:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Envelope files"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Message bodies"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Attachments"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The platform retrieves content from object storage during processing."]}]},"headings":[{"value":"Glossary","id":"glossary","depth":1},{"value":"Delivery","id":"delivery","depth":2},{"value":"Envelope","id":"envelope","depth":2},{"value":"Message","id":"message","depth":2},{"value":"Sender Identity","id":"sender-identity","depth":2},{"value":"Organisation Account","id":"organisation-account","depth":2},{"value":"Platform Holder","id":"platform-holder","depth":2},{"value":"Receiver","id":"receiver","depth":2},{"value":"Recipient","id":"recipient","depth":2},{"value":"Identity","id":"identity","depth":2},{"value":"System Integration","id":"system-integration","depth":2},{"value":"Delivery Report","id":"delivery-report","depth":2},{"value":"Atomic Delivery","id":"atomic-delivery","depth":2},{"value":"Interim Repository","id":"interim-repository","depth":2},{"value":"Message Lifecycle","id":"message-lifecycle","depth":2},{"value":"Client-Side Encryption","id":"client-side-encryption","depth":2},{"value":"Processing","id":"processing","depth":2},{"value":"Delivery Status","id":"delivery-status","depth":2},{"value":"Message Identifier ( messageId )","id":"message-identifier--messageid-","depth":2},{"value":"Object Storage","id":"object-storage","depth":2}],"frontmatter":{"seo":{"title":"Glossary"}},"lastModified":"2026-02-19T12:20:29.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/documentation/glossary","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}