bert.hausmans/crewli-old
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat: complete email infrastructure with queue, templates, logging, and API

Browse Source 
Adds the full transactional email system:
- Redis queue (QUEUE_CONNECTION=redis), SES config in .env.example
- 3 migrations: organisation_email_settings, organisation_email_templates, email_logs
- EmailTemplateType and EmailLogStatus enums with Dutch defaults
- EmailService as central entry point for all email sending
- SendTransactionalEmail queued job with retries and idempotency
- TransactionalMail mailable with responsive HTML + plain text templates
- Organisation-level branding (colors, logo, footer, reply-to)
- Per-type template overrides with {variable} substitution
- Email log with filtering by status, type, date range, recipient
- Preview and send-test endpoints for template management
- API endpoints: email-settings, email-templates (CRUD), email-logs (read-only)
- Integrated into existing flows: invitations, password reset, email
  verification, registration approval/rejection
- 37 new tests across 4 test files, all existing tests updated

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This commit is contained in:
bert.hausmans
2026-04-15 20:12:21 +02:00
parent c64875b6ef
commit 65978104d8
42 changed files with 2420 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
dev-docs/API.md
View File

@@ -922,3 +922,121 @@ Base path: `/api/v1/admin/`
- Impersonation token has name `impersonation-by-{admin_id}`
- Admin ID is cached for 4 hours at key `impersonation:{token_id}`
- Activity log records both start (`admin.impersonation.started`) and stop (`admin.impersonation.stopped`)
## Email Settings (org admin)
- `GET /organisations/{org}/email-settings` — get current email branding settings (returns defaults if none configured)
- `PUT /organisations/{org}/email-settings` — create or update email branding settings
### PUT body
```json
{
"logo_url": "https://example.com/logo.png",
"primary_color": "#FF5500",
"secondary_color": "#CC4400",
"footer_text": "© 2026 Stichting Feestfabriek",
"reply_to_email": "info@festival.nl",
"reply_to_name": "Festival Team"
}
```
All fields are optional/nullable. Colors must match `#[0-9A-Fa-f]{6}`.
## Email Templates (org admin)
- `GET /organisations/{org}/email-templates` — list all template types with current content (custom or default)
- `GET /organisations/{org}/email-templates/{type}` — get single template with both custom content and defaults
- `PUT /organisations/{org}/email-templates/{type}` — create or update custom template for this type
- `DELETE /organisations/{org}/email-templates/{type}` — reset to system default (deletes custom override)
- `POST /organisations/{org}/email-templates/{type}/preview` — render email HTML with sample data
- `POST /organisations/{org}/email-templates/{type}/send-test` — send test email. Body: `{ "email": "test@example.com" }`
### Template types
`invitation`, `password_reset`, `email_verification`, `registration_approved`, `registration_rejected`, `shift_assignment`
### PUT body
```json
{
"subject": "Aangepaste uitnodiging voor {organisation_name}",
"heading": "Welkom!",
"body_text": "Aangepaste tekst met {organisation_name} variabelen.",
"button_text": "Klik hier"
}
```
### GET response (index)
Returns array of all template types with resolved content:
```json
{
"data": [
{
"type": "invitation",
"label": "Uitnodiging",
"is_custom": false,
"subject": "Je bent uitgenodigd voor {organisation_name}",
"heading": "Welkom bij {organisation_name}!",
"body_text": "...",
"button_text": "Uitnodiging accepteren",
"defaults": { "subject": "...", "heading": "...", "body_text": "...", "button_text": "..." }
}
]
}
```
### Template variables
- `{organisation_name}` — available in all templates
- `{event_name}` — available in registration and shift templates
- `{shift_title}`, `{shift_date}`, `{shift_start}`, `{shift_end}`, `{section_name}` — shift assignment only
## Email Logs (org admin, read-only)
- `GET /organisations/{org}/email-logs` — paginated email log
### Query parameters
| Param | Type | Description |
| --------------- | ------ | ------------------------------------ |
| `search` | string | Search by recipient_email |
| `status` | string | Filter: `queued\|sent\|failed` |
| `template_type` | string | Filter by EmailTemplateType |
| `event_id` | ULID | Filter by event |
| `person_id` | ULID | Filter by person |
| `from` | date | Start of date range |
| `to` | date | End of date range |
| `per_page` | int | Results per page (default 15) |
### Response
```json
{
"data": {
"data": [
{
"id": "01JXYZ...",
"recipient_email": "volunteer@test.nl",
"recipient_name": "Jan Janssen",
"template_type": "registration_approved",
"template_label": "Registratie goedgekeurd",
"subject": "Je registratie voor Festival X is goedgekeurd!",
"status": "sent",
"error_message": null,
"queued_at": "2026-04-15T12:00:00+00:00",
"sent_at": "2026-04-15T12:00:05+00:00",
"failed_at": null,
"triggered_by": { "id": "01JXYZ...", "name": "Admin User" },
"event_id": "01JXYZ...",
"person_id": "01JXYZ...",
"created_at": "2026-04-15T12:00:00+00:00"
}
],
"links": { "...pagination..." },
"meta": { "...pagination..." }
}
}
```

73
dev-docs/SCHEMA.md
View File

@@ -1760,3 +1760,76 @@ Exception: when `shifts.allow_overlap = true`, the **application layer** skips t
- Any role explicitly marked as overlap-allowed in the planning document
The DB constraint remains as a safety net for all other cases.
---
## 3.5.10 Email Infrastructure
### `organisation_email_settings`
Per-organisation email branding configuration. One-to-one with organisations.
| Column | Type | Notes |
| ------------------ | ------------------ | ---------------------------------------- |
| `id` | ULID | PK |
| `organisation_id` | ULID FK | → organisations, UNIQUE, CASCADE DELETE |
| `logo_url` | string(500) nullable | Logo URL for email header |
| `primary_color` | string(7) | Hex color, default `#6366F1` |
| `secondary_color` | string(7) | Hex color, default `#4F46E5` |
| `footer_text` | string(200) nullable | Custom footer text |
| `reply_to_email` | string nullable | Override reply-to per org |
| `reply_to_name` | string(100) nullable | Reply-to display name |
**Relations:** `belongsTo` organisation
**Soft delete:** no
---
### `organisation_email_templates`
Per-organisation, per-type email text overrides. When no override exists, system defaults from `EmailTemplateType` enum are used.
| Column | Type | Notes |
| ------------------ | ------------------ | --------------------------------------------------- |
| `id` | ULID | PK |
| `organisation_id` | ULID FK | → organisations, CASCADE DELETE |
| `type` | string(50) | `EmailTemplateType` enum value |
| `subject` | string(200) | Custom subject line |
| `heading` | string(200) nullable | Custom heading in email body |
| `body_text` | text | Custom body text (supports `{variable}` placeholders) |
| `button_text` | string(100) nullable | Custom CTA button label |
**Unique constraint:** `UNIQUE(organisation_id, type)`
**Relations:** `belongsTo` organisation
**Soft delete:** no
**Template types:** `invitation`, `password_reset`, `email_verification`, `registration_approved`, `registration_rejected`, `shift_assignment`
---
### `email_logs`
Immutable audit record of every email sent. No soft deletes.
| Column | Type | Notes |
| ---------------------- | ------------------ | ----------------------------------------------- |
| `id` | ULID | PK |
| `organisation_id` | ULID FK nullable | → organisations, NULL ON DELETE |
| `event_id` | ULID FK nullable | → events, NULL ON DELETE |
| `person_id` | ULID nullable | Person context if applicable |
| `user_id` | ULID nullable | User context if applicable |
| `recipient_email` | string | |
| `recipient_name` | string nullable | |
| `mailable_class` | string | e.g. `App\Mail\TransactionalMail` |
| `template_type` | string(50) | `EmailTemplateType` enum value |
| `subject` | string | Resolved subject (after variable substitution) |
| `status` | string(20) | `queued\|sent\|failed` |
| `error_message` | text nullable | Failure reason |
| `queued_at` | timestamp | |
| `sent_at` | timestamp nullable | |
| `failed_at` | timestamp nullable | |
| `triggered_by_user_id` | ULID nullable | Who triggered the email |
**Indexes:** `(organisation_id, created_at)`, `(recipient_email, created_at)`, `(template_type, status)`, `(event_id)`, `(person_id)`
**Relations:** `belongsTo` organisation (nullable), event (nullable), person (nullable), user (nullable), triggeredBy → user
**Soft delete:** no — immutable audit table