Settings

The fields that fill in Sendoff's email layout and signup page.

Settings live in Sendoff’s database, not in code, so you change them by asking your agent (“make the accent color #ff0066”, “add my GitHub link”), and updating Sendoff never overwrites them. Setup fills in the first few. Changes show in the preview straight away and apply to every email sent afterwards.

{
  "name": "The Weekly Thing",
  "description": "A short letter about building things, every few months.",
  "from": { "name": "Jane Doe", "email": "hello@example.com" },
  "replyTo": "jane@example.com",
  "address": "1 Example St, Sydney NSW 2000, Australia",
  "accent": "#ff0066",
  "logo": {
    "url": "https://example.com/logo.png",
    "darkUrl": "https://example.com/logo-dark.png",
    "width": 120,
    "height": 32
  },
  "links": [
    { "label": "Website", "url": "https://example.com" },
    { "label": "X", "url": "https://x.com/example" }
  ],
  "tracking": { "clicks": true, "opens": false }
}

namestringrequired

Your newsletter’s or brand’s name, shown in the masthead (unless there’s a logo), the footer and the signup page.

fromobjectrequired

The sender’s name and email. The email’s domain must be verified in SES before you can send; setup does this for the address you give it.

addressstring

The postal address in every footer: a street address, PO box or private mailbox, not just a city. US and Canadian law require one in commercial email, like launches and promotions. Without one, prepare_send checks each issue and blocks any that read as commercial. See When you need a postal address.

replyTostring

Where replies go, if not the sender. Tests go here by default too.

descriptionstring

One or two sentences for the signup page.

accentstring

A #rrggbb color for links, buttons and callouts. Where text in it would be hard to read, Sendoff adjusts it to meet WCAG AA contrast, in light and dark mode.

logoobject

An https image url with its display width and height in pixels, which email clients need up front. darkUrl is an optional version for dark mode. Without a logo, the masthead shows the name.

linksobject[]

Footer links, each a label and url. Setting them replaces the whole list.

trackingobject

What issue stats can measure. clicks (on by default) sends links in the HTML email through your Sendoff domain to count clicks. opens (off by default) adds a 1×1 image to count opens. Changes apply to issues sent afterwards.

null clears an optional field, such as "logo": null to go back to showing the name. For text fields (address, description and reply-to), an empty string does too.