Skip to main content

email-service documentation

email-service sends Shellui mail. The HTTP API lives at https://email.shellui.com. This docs site is published separately so the API host stays an API.

Contract​

Other Shellui services and the admin app implement against integration.md. That page lists environment variables, every endpoint, request and response shapes, error codes, retries, and idempotency.

Guides​

  • Authentication: service keys and identity JWTs
  • Providers: Resend, SMTP, and how to add Mailjet
  • Library: built-in designs and company templates
  • Templates: event copies, editor documents, versions, and variables
  • Rules: company email rules and built-in auth mail
  • Broadcasts: one email to many users, each in their language
  • Newsletters: public sign-up with double opt-in, lists, and sending issues
  • Lanes: auth, transactional, and bulk
  • Events: catalog events for identity, storage, and hosting
  • Metrics: admin stats and Prometheus
  • Shellui Actions: outbound webhooks
  • n8n: receiving those webhooks
  • Configuration: environment variables
  • Security: credentials, suppressions, and link hosts

Project setup is in README.md. Image publishing is in PUBLISH.md.