Email Inventory
Complete list of all emails shipped by default and how to disable each.
Email Inventory
Complete inventory of all emails and configuration options.
Overview
The kit ships with 15 email templates covering authentication, account management, and organization workflows. All templates are located in packages/email-templates/src/emails/ and use React Email for rendering.
Emails are categorized into:
- Authentication Emails - Sign-in, verification, password reset
- Account Management Emails - Email changes, account deletion
- Organization Emails - Team invitations
- Admin Emails - User moderation (templates exist, not wired yet)
- Generic Templates - Reusable templates for custom use cases
Authentication Emails
| Template | When Sent | |
|---|---|---|
| Magic Link | magic-link.email.tsx | User requests passwordless sign-in via magic link |
| Email Verification | email-verification.email.tsx | New user signs up (link-based verification) |
| Reset Password | reset-password.email.tsx | User requests password reset |
| OTP Sign-In | otp-sign-in.email.tsx | User signs in via OTP code |
| OTP Email Verification | otp-email-verification.email.tsx | New user signs up (OTP-based verification) |
| OTP Password Reset | otp-password-reset.email.tsx | User resets password via OTP code |
Account Management Emails
| Template | When Sent | |
|---|---|---|
| Change Email Confirmation | change-email-confirmation.email.tsx | User initiates email change (sent to current email) |
| Change Email Verification | change-email-verification.email.tsx | User changes email (sent to new email) |
| Delete Account OTP | delete-account-otp.email.tsx | User initiates account deletion |
Organization Emails
| Template | When Sent | |
|---|---|---|
| Invitation | invite.email.tsx | Member is invited to join an organization |
Admin Emails (Templates Only)
These templates exist but are not currently wired to send automatically:
| Template | Purpose | |
|---|---|---|
| User Banned | user-banned.email.tsx | Notify user their account was suspended |
| User Unbanned | user-unbanned.email.tsx | Notify user their account was restored |
| Account Deleted | account-delete.email.tsx | Confirm account deletion |
Generic Templates
Reusable email templates for building custom emails:
| Template | Purpose | |
|---|---|---|
| OTP | otp.email.tsx | Generic OTP email with i18n support. Used as base for sign-in, verification, and password reset OTPs |
| Verification | verification.email.tsx | Flexible verification template with customizable heading, body, code label, and optional warning message |
Using the Generic Verification Template
The verification.email.tsx template accepts these props:
interface Props { code: string; // The verification code to display productName: string; // Name shown in footer heading: string; // Email heading body: string; // Main body text codeLabel: string; // Label before the code warning?: string; // Optional warning message (shown in red) variant?: 'default' | 'destructive'; // Button style}Using the Generic OTP Template
The otp.email.tsx template accepts these props and supports internationalization:
interface Props { otp: string; // The one-time password code productName: string; // Name of the product/service language?: string; // Language code for i18n}Template Locations
All email templates are in packages/email-templates/src/emails/:
packages/email-templates/src/emails/├── account-delete.email.tsx├── change-email-confirmation.email.tsx├── change-email-verification.email.tsx├── delete-account-otp.email.tsx├── email-verification.email.tsx├── invite.email.tsx├── magic-link.email.tsx├── otp.email.tsx├── otp-email-verification.email.tsx├── otp-password-reset.email.tsx├── otp-sign-in.email.tsx├── reset-password.email.tsx├── user-banned.email.tsx├── user-unbanned.email.tsx├── verification.email.tsxTo customize an email template, edit the corresponding file and the changes will apply to all sent emails.