Quick Start E-mail

Write an e-mail in Novem Markdown, check a test delivery, and send it to your recipients.

AI-assisted, human-approvednovem uses AI to review and keep our documentation up to date.

Prerequisites

You need a novem account, the novem CLI, and a confirmed e-mail address on your account. Complete the CLI setup with novem --init before starting.

Your plan controls which recipients you can send to. See recipient restrictions.

1. Create the e-mail

Create an e-mail named example_report, set its subject, and add yourself as the recipient:

novem -m example_report -C
novem -m example_report --subject "Example weekly summary"
novem -m example_report --to me

me refers to the confirmed e-mail address on your novem account. Setting a recipient does not send the e-mail.

2. Write the content

Create a local file named email.md with the following content. The completion counts are fictional; the embedded chart uses the public Novem Example Index dataset.

{{ preview }}
Example weekly summary: 20 of 25 tasks completed.
{{ /preview }}

# Example weekly summary

The fictional project completed 20 of its 25 tasks this week.
The remaining 5 tasks are scheduled for next week.

## Demo chart

The chart below uses the Novem Example Index demo dataset.

{{ vis ref: /u/novem_demo/p/nei_rgn_perf, width: 100% }}

The preview block supplies the short text shown in inbox lists. It does not appear in the e-mail body. The vis block embeds a plot. See Novem Markdown for other blocks and formatting options.

Upload the file:

novem -m example_report -w content @email.md

You can also upload the content through standard input:

cat email.md | novem -m example_report

3. Send a test

Send a test copy to your confirmed e-mail address:

novem -m example_report -T

-T ignores the configured To, Cc, and Bcc lists. Check the subject, preview text, body, and chart in your inbox. If you edit email.md, upload it again before sending another test.

4. Set recipients and send

The e-mail is currently addressed to you. To use another recipient, replace the example address below with the intended address:

novem -m example_report --to reader@example.com --cc me

Use --to, --cc, and --bcc to set the respective recipient lists. Use bare e-mail addresses and separate multiple recipients with commas. Novem usernames and group identifiers are also supported; see Recipients.

When the content and recipients are correct, send the e-mail:

novem -m example_report -S

-S sends to all configured To, Cc, and Bcc recipients. See Sending for delivery status and send history.

Documents

Repos