trails/openspec/specs/transactional-emails/spec.md
Ullrich Schäfer 0b9b99984e Fix all OpenSpec validation failures (36/36 passing)
- Add ## Purpose sections and convert delta headers to ## Requirements
  on all 25 specs
- Add SHALL keywords to requirements missing them (gpx-import,
  planner-session, planner-journal-handoff)
- Convert prose GPX format section to proper scenarios (no-go-areas)
- Create specs/ delta files for 7 changes that were missing them
  (activity-photos, local-dev-stack, multi-day-routes, route-discovery,
  route-sharing, visual-redesign, waypoint-notes)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
2026-04-06 22:17:52 +02:00

2 KiB

Purpose

Transactional email sending with HTML and plain-text templates for magic links and welcome messages, using SMTP in production and console logging in dev.

Requirements

Requirement: Email sending interface

The system SHALL provide a provider-agnostic email sending function that supports HTML and plain-text content.

Scenario: Send email in production

  • WHEN the system sends a transactional email in production
  • THEN the email is delivered via Nodemailer with SMTP (configured via SMTP_URL connection string and SMTP_FROM env var) to the recipient

Scenario: Dev mode skips sending

  • WHEN the system sends a transactional email in development
  • THEN the email content is logged to console and no external API is called

The system SHALL send an email containing the magic link when a user requests passwordless login.

  • WHEN a user requests a magic link login
  • THEN an email is sent with a clickable link that logs them in

Scenario: Email content

  • WHEN a magic link email is sent
  • THEN it includes: the link, expiry time (15 minutes), and plain-text fallback

Requirement: Welcome email

The system SHALL send a welcome email after successful registration.

Scenario: Welcome on registration

  • WHEN a user completes passkey registration
  • THEN a welcome email is sent to their registered email address

Requirement: Email templates

Each email type SHALL have an HTML template with a plain-text fallback.

Scenario: Extensible template pattern

  • WHEN a new email type is needed in the future
  • THEN it can be added by creating a template function and calling sendEmail

Requirement: Privacy disclosure

Email sending SHALL be documented in the privacy manifest.

Scenario: Privacy manifest updated

  • WHEN transactional emails are enabled
  • THEN the /privacy page documents: what emails are sent, that email addresses are shared with the email provider, and which provider is used