Skip to content

Introduce bodyFormat for Mails #392

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
britsta merged 5 commits into from
Dec 4, 2025
Merged

Introduce bodyFormat for Mails #392

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4ea4daf
feat: introduce bodyFormat property of Mail
britsta Dec 2, 2025
f414277
feat: set bodyFormat in example Mail
britsta Dec 2, 2025
1785ac0
feat: add content.bodyFormat as query parameter for Messages
britsta Dec 2, 2025
fdf13ca
refactor: remove unnecessary commas
britsta Dec 2, 2025
7a32e9d
feat: add more detailed description to bodyFormat
britsta Dec 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions _docs_integrate/data-model-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion _docs_integrate/integration-example.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
```
Expand Down
5 changes: 3 additions & 2 deletions _docs_use-cases/use-case-transport-query-messages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down