mail

package

v1.3.0 Latest Latest Go to latest Published: Aug 17, 2026 License: AGPL-3.0 Imports: 14 Imported by: 0

Details

Cross-repo behaviour and ops: docs/github/transactional-email.md (sibling docs repo).

This module owns:

Templates live in modules/user/mail/templates/. Iterate locally with Mailpit; do not treat SES console templates as source of truth.

This section is empty.

View Source

var (
	ErrRateLimited = errors.New("email rate limited")
	ErrDisabled    = errors.New("smtp disabled")
)

This section is empty.

type Mailer interface {
	Send(ctx context.Context, msg Message) error
}

Mailer sends transactional email.

func NewNoopMailer() Mailer

func NewSMTPMailer(cfg SMTPConfig) Mailer

type Message struct {
	To       string
	Subject  string
	TextBody string
	HTMLBody string
}

Message is a transactional email payload.

type RateLimitedMailer struct {
	// contains filtered or unexported fields
}

RateLimitedMailer wraps a Mailer with a process-local rolling hourly send cap. Assumes a single backend instance.

func NewRateLimitedMailer(inner Mailer, hourlyLimit int) *RateLimitedMailer

func (m *RateLimitedMailer) Send(ctx context.Context, msg Message) error

type RenderedEmail struct {
	Subject  string
	TextBody string
	HTMLBody string
}

func RenderEmailVerify(data TemplateData) (RenderedEmail, error)

func RenderPasswordReset(data TemplateData) (RenderedEmail, error)

type SMTPConfig struct {
	Host     string
	Port     int
	Username string
	Password string
	From     string
	FromName string
}

SMTPConfig holds SES SMTP (or compatible) connection settings.

type TemplateData struct {
	Username   string
	ActionURL  string
	ExpiryNote string
}