Mails

Config

Every option lives as a plain-text file under the e-mail's config/ folder. Read it with GET, set it with POST, and reset it to its default with DELETE.

AI assisted, human approved — novem uses AI to review and keep our documentation up to date.

E-mail configuration follows the everything-is-a-file pattern: each option is a small plain-text file under /v1/vis/mails/:mail/config/. You write a value with a POST, read it back with a GET, and a DELETE restores the default:

POST/v1/vis/mails/weekly_report/config/subject
Weekly report — week 24

KeyDefaultValuesDescription
subject(empty)free textThe subject line of the e-mail
sizesmallxs, s, m, l (or spelled out)Content width of the rendered e-mail
themenovem-lightnovem, novem-light, novem-darkColor theme used for the render
typesimplesimpleThe e-mail layout — simple is currently the only layout
reply_tonoyes / noSet to yes to add your registered e-mail address as the Reply-To header
enabledtruetruthy / falsyKill switch: a falsy value blocks production sends
commentstruetrue / falseWhether viewers can open comment threads on the e-mail's web page

The size controls the rendered content width. Both the short and the spelled out forms are accepted:

ValueWidth
xs / extra small400 px
s / small600 px
m / medium900 px
l / large1200 px

An unrecognised value falls back to the default small.

novem and novem-light are light renders, novem-dark is the dark variant. An unrecognised theme falls back to novem. Terminal (ansi) renders produce both a light and a dark variant regardless.

The send kill switch. The values no, n, nope, false, f, and off count as falsy. While one of them is set, a production send is rejected with a 403 and a note in the e-mail's /log. Test sends (see sending) are exempt, so you can keep iterating on a disabled e-mail safely.

By default, novem e-mails are sent from a no-reply address. Set reply_to to exactly yes and the Reply-To header of outgoing mails points to your registered novem e-mail address, so recipients can answer you directly.

Controls the comment threads on the e-mail's web view. With comments set to false, creating new topics and comments is blocked. Existing comments remain visible.

Note: writes are plain text: no quotes, no JSON. A trailing newline is fine and ignored.

The read-only file /v1/vis/mails/:mail/json/config.json returns the active configuration as a single JSON document, convenient when you want a snapshot instead of one request per key.