mail

Documentation

Overview

Package mail implements the bundled txco://sendmail op: it reads the `_sendmail` envelope contract a rule assembled, renders an email (the bundled default template wrapping the body), enforces the per-tenant campaign at-most-once guard, verifies the From domain, submits to a relay, and emits a usage line. Phase 1 = the common case (to/subject/body/from); custom FILES/ templates, attachments, and policy caps are later phases (see internal docs/todo-sendmail.md).

Index

• Variables
• type Config
• type Mailer
  • func NewMailer(db *sql.DB, u usage.Sink, log *zap.Logger, cfg Config) *Mailer
  • func (m *Mailer) Send(ctx context.Context, tenant string, in []byte) (event.Payload, error)
• type SubmitFunc

Variables

var ErrNoRelay = errors.New("sendmail: no mail relay configured (set --mail-relay-addr / TXCO_MAIL_RELAY_ADDR)")

ErrNoRelay is returned by the op when no relay is configured.

Types

type Config

type Config struct {
	RelayAddr     string
	RelayTLS      string // "none" | "starttls"
	DialTimeout   time.Duration
	MaxRecipients int
	RateLimits    string // per-tenant send caps, e.g. "100/2m,200/4h"; empty disables
}

Config carries the relay + limits resolved from chassis config.

type Mailer

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

Mailer is the txco://sendmail handler with its injected deps. db is the REAL, writable runtime *sql.DB (stable — dbcache only swaps its in-memory snapshot, not this handle), used for the campaign claim and the From-domain check. usage is nil-safe. submit is injectable (real SMTP in prod, a fake in tests).

func NewMailer

func NewMailer(db *sql.DB, u usage.Sink, log *zap.Logger, cfg Config) *Mailer

NewMailer builds a Mailer. db must be the real runtime DB (e.g. pu.RuntimeDB); usage/log may be nil.

func (*Mailer) Send

func (m *Mailer) Send(ctx context.Context, tenant string, in []byte) (event.Payload, error)

Send is the op body. tenant is the PINNED request tenant (resolved by the caller from the trusted context, NOT the mutable envelope) — load-bearing for the campaign key and the From-domain anti-spoof check.

type SubmitFunc

type SubmitFunc func(ctx context.Context, from string, rcpts []string, msg []byte) error

SubmitFunc hands one rendered RFC 5322 message to the relay for `from` → `rcpts` (the envelope recipients: the To recipient plus any Cc/Bcc). Injectable so tests can substitute a fake.