nyxa-mail — batteries-included mail for Nyxa

Log/file mailer by default (no SMTP required). Optional SMTP, SES, and Mailgun.

At a glance

Install

uv add nyxa-mail
uv add 'nyxa-mail[ses]'      # boto3
uv add 'nyxa-mail[mailgun]'  # httpx

Quick start

from nyxa_mail import Mailable, mail

class WelcomeMail(Mailable):
    def __init__(self, name: str) -> None:
        super().__init__()
        self.name = name

    def text(self) -> str:
        return f"Welcome, {self.name}!\n"

mail.send(WelcomeMail("Ada").to("ada@example.com").subject("Welcome"))

Configuration

MAIL_MAILER=log
MAIL_FROM=app@example.com

# MAIL_MAILER=smtp
# MAIL_HOST=... MAIL_PORT=587 MAIL_USERNAME=... MAIL_PASSWORD=...

# MAIL_MAILER=ses
# AWS_ACCESS_KEY_ID=... AWS_SECRET_ACCESS_KEY=... AWS_DEFAULT_REGION=us-east-1

# MAIL_MAILER=mailgun
# MAILGUN_DOMAIN=mg.example.com
# MAILGUN_API_KEY=key-...
# MAILGUN_API_BASE=https://api.eu.mailgun.net   # optional (EU)

CLI

uv run nyxa mail test --to you@example.com