Mails

Use novem e-mails to send Markdown content with embedded plots. The API provides endpoints for content, recipients, configuration, and sending.

For a complete example, follow the quick start.

Structure

An e-mail stores its body in content. Separate files and folders hold its subject, recipients, assets, and send history:

daily_email_summary      => E-mail Name
├── config               => Configuration options
│   ├── theme            => Color theme for the e-mail
│   ├── type             => Layout type for the e-mail
│   ├── reply_to         => Add your registered e-mail as reply-to
│   ├── size             => E-mail size xs | s | m | l
│   ├── subject          => Subject line of the e-mail
│   ├── enabled          => Kill switch for production sends
│   └── options          => Behavioural switches
│       └── comments     => Allow comments on the web view
├── recipients           => Who should receive the e-mail
│   ├── to               => List of primary recipients
│   ├── cc               => List of cc recipients
│   └── bcc              => List of bcc recipients
├── content              => Content of e-mail
├── status               => Trigger sends, poll progress
├── stats                => Send history
├── files                => Rendered outputs (txt, ansi, pdf, png, pptx)
├── assets               => Uploaded images and fonts for embedding
├── vars                 => Attached metadata variables
├── tags                 => Tags on the e-mail
├── threads              => Comment threads from the web view
├── log                  => Activity log (sends, recipient changes, errors)
├── url                  => Web url of the e-mail (read only)
├── shortname            => Auto-generated shortname (read only)
├── description          => Description (meta)
├── summary              => Short summary of e-mail (meta)
├── name                 => Name (meta)
└── shared               => Who can view the e-mail in the web format
    ├── +org~group       => Shared with an org group
    ├── @username~group  => Shared with a user group
    └── public           => Shared with everyone

Creating an e-mail

Create an e-mail with PUT /v1/vis/mails/MAIL_NAME, or use the CLI or Python library. These examples upload a local email.md file and send a test to the confirmed address on your account.

novem -m example_report -C
novem -m example_report --subject "Example weekly summary"
novem -m example_report -w content @email.md
novem -m example_report -T

Reference

• Overview — the full e-mail API surface.
• Content — the mail content format.
• Recipients — address formats and tier restrictions.
• Config — subject, size, theme and the other options.
• Sending — test sends, rate limits and send status.
• Renders — txt, ansi, pdf, png and pptx outputs.
• Novem Markdown — syntax and supported blocks.
• Python Mail — build mails programmatically.