Skip to content
Last updated

Message envelope

This should be reviewed by a developer or architect

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.

Envelope Components

  • 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.
  • Sender: Specifies the originator of the message, visible to recipients. It also determines available features, depending on permissions set on the Sender.
  • Message Content: References to files that will be delivered as the body of the message or attached to the message.
  • Message Features: Includes additional functionalities, such as:
    • Scheduled Delivery: Postpones delivery to a scheduled time.
    • Interim message: Holds messages for recipients without an account, to be delivered when they join the platform.
    • Open Receipt: Registers a receipt when recipients access the message.

envelope schema

envelope-schema_1.0.2.json

attachmentsArray of objects, <= 20 items(file)

List of attachments included in the message.

bodyobject(file)required

Main message body file.

deliverAtstring, (date-time)(datetime)

Scheduled delivery timestamp in RFC 3339 format. The message is processed immediately, but delivery is deferred until this time.

messageIdstring, <= 71 characters^[a-zA-Z0-9/\\._-]+$required

Unique identifier for the message within the sender organization.

recipientsArray of objects, [ 1 .. 10 ] items(userRecipient)required

List of message recipients.

requireOpenReceiptboolean

If true, an open receipt must be registered before the recipient can access the message content. Only supported for single recipient envelopes.

Default:false
senderobject(batchSender)required

Details of the message sender, used for recipient display and feature authorization.

titlestring, <= 101 charactersrequired

Title of the message shown to recipients. Do not include sensitive data.