diff --git a/_docs_integrate/data-model-overview.md b/_docs_integrate/data-model-overview.md index 003fe302d..1709bd1ff 100644 --- a/_docs_integrate/data-model-overview.md +++ b/_docs_integrate/data-model-overview.md @@ -1191,13 +1191,14 @@ When receiving a [RelationshipTemplate](#relationshiptemplate) with an [Arbitrar A Mail can be sent as the content of a [Message](#message). It is comparable with the classic email, so its properties should be familiar. -| Name | Type | Description | -| ------- | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| @type | `"Mail"` | | -| to | `string[]` | The enmeshed addresses of the main recipients of this Mail without duplicates. Only `recipients` of the Message may be specified here. | -| cc | `string[]` \| `undefined` | The enmeshed addresses without duplicates that should receive a copy of this Mail, additionally to the enmeshed addresses of the main recipients specified in `to`. Only `recipients` of the Message which are not main recipients of the Mail can receive a copy of it. | -| subject | `string` | The subject of the Mail. | -| body | `string` | The body of the Mail. | +| Name | Type | Description | +| ---------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| @type | `"Mail"` | | +| to | `string[]` | The enmeshed addresses of the main recipients of this Mail without duplicates. Only `recipients` of the Message may be specified here. | +| cc | `string[]` \| `undefined` | The enmeshed addresses without duplicates that should receive a copy of this Mail, additionally to the enmeshed addresses of the main recipients specified in `to`. Only `recipients` of the Message which are not main recipients of the Mail can receive a copy of it. | +| subject | `string` | The subject of the Mail. | +| body | `string` | The body of the Mail. | +| bodyFormat | `"PlainText"` \| `"Markdown"` | The format of the body of the Mail. It is used in the App to display the body of the Mail according to the specified format. | ## ArbitraryMessageContent diff --git a/_docs_integrate/integration-example.md b/_docs_integrate/integration-example.md index affa1f42f..c711bdff5 100644 --- a/_docs_integrate/integration-example.md +++ b/_docs_integrate/integration-example.md @@ -263,7 +263,8 @@ Further, the `subject` and `body` properties can be modified with some custom `c "@type": "Mail", "to": ["did:e:_________________________________"], "subject": "Welcome", - "body": "Hello. We are pleased to welcome you as our customer." + "body": "Hello. We are pleased to welcome you as our customer.", + "bodyFormat": "PlainText" } } ``` diff --git a/_docs_use-cases/use-case-transport-query-messages.md b/_docs_use-cases/use-case-transport-query-messages.md index 84ad504d6..aec1998a2 100644 --- a/_docs_use-cases/use-case-transport-query-messages.md +++ b/_docs_use-cases/use-case-transport-query-messages.md @@ -57,8 +57,9 @@ All parameters are optional. If no parameter is given, all Messages are returned - `recipients.relationshipId` are the [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) ids of the respective recipient. - `participant` is either the enmeshed address of the sender or enmeshed addresses of the Identities the Message was sent to. - `content.@type` the type of structure of the Message's content -- `content.body` the body of the Mail, if the Message is of type Mail -- `content.subject` the subject of the Mail, if the Message is of type Mail +- `content.body` the body of the Mail if the Message is of type Mail +- `content.bodyFormat` the format of the body of the Mail if the Message is of type Mail +- `content.subject` the subject of the Mail if the Message is of type Mail ## On Success