Conversion table
Here are the tables that specify how incoming Rich Text and outgoing Rich Text are converted.
Note
All incoming and outgoing conversions shown here are the default processes. See Extending Rich Text for instructions on extending Rich Text processing.
Incoming Rich Text
Incoming Rich Text is the Rich Text JSON specified on the request body as the value of a richtext field.
The following table is a matrix for submitted types together with its supported createAdditional switches and how it's stored as.
Note
createAdditional is an optional property in the Rich Text JSON that you use to specify what alternative types to create additionally from the original content. It saves a multipart/alternative MIME that contains the original content type and the specified types in the create additional property. Currently, the available values for createAdditional are plain and html.
| Submitted type | createAdditional | Stored as | Example |
|---|---|---|---|
| multipart/mixed | - | multipart/mixed | Example |
| multipart/alternative | - | multipart/alternative | Example |
| text/plain | - | text/plain | Example |
| text/html | - | text/html | Example |
| text/html | plain | - multipart/alternative - text/html |
Example |
| text/markdown | - | text/markdown | Example |
| text/markdown | plain | - multipart/alternative - text/markdown - text/plain |
Example |
| text/markdown | html | - multipart/alternative - text/markdown - text/html |
Example |
| text/markdown | plain, html | - multipart/alternative - text/markdown - text/plain - text/html |
Example |
Warning
Updating the richtext field in Notes client may alter what Domino REST API has stored in it. For example, a stored multipart/alternative gets overwritten if the richtext field is updated using the Notes client.
Outgoing Rich Text
Outgoing Rich Text is how the value of the richtext field is shown in the response body.
The following table shows the content of the richtext field, its different richTextAs values, and their corresponding results.
| Content | richTextAs | Result type | Notes | Example |
|---|---|---|---|---|
| Rich Text | mime | multipart/mixed | Example | |
| Rich Text | html | text/html | Example | |
| Rich Text | plain | text/plain | Example | |
| Rich Text | markdown | text/markdown | Example | |
| MIME | mime | multipart/mixed | Example 1 Example 2 |
|
| MIME | html | text/html | Fallbacks: - text/markdown → html |
Example 1 Example 2 Example 3 Example 4 |
| MIME | markdown | text/markdown | Fallbacks: - text/html → markdown |
Example 1 Example 2 Example 3 Example 4 |
| MIME | plain | text/plain | Fallbacks: - text/html → plain - text/markdown → plain |
Example 1 Example 2 Example 3 Example 4 Example 5 |