Settings Reference¶

All settings are read from your Django settings module.

Required¶

Setting	Type	Description
`LETTERMINT_API_KEY`	`str`	Your project API token from the Lettermint dashboard

Optional¶

Setting	Type	Default	Description
`LETTERMINT_BASE_URL`	`str`	SDK default	Override the Lettermint API base URL
`LETTERMINT_ROUTE`	`str`	`None`	Default route applied to all outgoing emails
`LETTERMINT_BULK_ROUTE`	`str`	`None`	Route applied to bulk sends, overriding `LETTERMINT_ROUTE` for those messages
`LETTERMINT_TIMEOUT`	`int`	SDK default	Request timeout in seconds
`LETTERMINT_BATCH_SIZE`	`int`	`500`	Messages per request for bulk sending. Assumes Lettermint's batch limit; check their documentation
`LETTERMINT_WEBHOOK_PATH`	`str`	`lettermint/message-events/`	Full path of the webhook endpoint, with `lettermint_django.urls` included at the root
`LETTERMINT_WEBHOOK_SECRET`	`str`	`None`	Signing secret of your Lettermint webhook. Required by the webhook endpoint when tracking is installed

Notes¶

LETTERMINT_ROUTE sets a default route for all messages. Individual messages can override this using extra_headers["X-Lettermint-Route"].
LETTERMINT_BULK_ROUTE applies to send_bulk() and send_bulk_mail() only, so list mail can go out on a different route than the rest of your email. Like LETTERMINT_ROUTE it takes a route slug. The type of that route in Lettermint, transactional or broadcast, is invisible from here. Precedence, highest first: the message's own X-Lettermint-Route header (which is what route= on send_bulk_mail() sets), the route= argument of send_bulk(), LETTERMINT_BULK_ROUTE, LETTERMINT_ROUTE, and finally the default route of your API key.
extra_headers["X-Lettermint-Tag"] sets the Lettermint tag of a message (for example a campaign name). It is stored on LmEmailMessage.tag when tracking is installed.
LETTERMINT_BASE_URL is rarely needed. Only set this if you are testing against a custom or staging Lettermint environment.
LETTERMINT_TIMEOUT accepts any value accepted by the underlying lettermint SDK (integer seconds).
LETTERMINT_WEBHOOK_PATH is read when lettermint_django.urls is imported. Include those URLs at the root of your URLconf; the setting is the whole path. Register exactly that path, trailing slash included, in Lettermint.
LETTERMINT_WEBHOOK_SECRET is only read by the webhook view. The view raises ImproperlyConfigured when it is missing, so a misconfigured endpoint fails loudly instead of silently rejecting deliveries. Tracking itself has no on/off setting: it is active whenever lettermint_django is in INSTALLED_APPS.

Example¶

import os

EMAIL_BACKEND = "lettermint_django.LettermintEmailBackend"
LETTERMINT_API_KEY = os.getenv("LETTERMINT_API_KEY")
LETTERMINT_ROUTE = "app-mail"
LETTERMINT_BULK_ROUTE = "app-lists"
LETTERMINT_TIMEOUT = 10