Skip to content

Commit 226673c

Browse files
authored
chore(docs): make clearer link between template and actual email (supabase#36712)
1 parent 34f764e commit 226673c

File tree

1 file changed

+42
-6
lines changed

1 file changed

+42
-6
lines changed

apps/docs/content/guides/local-development/customizing-email-templates.mdx

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,49 @@ content_path = "./supabase/templates/invite.html"
3232

3333
## Available email templates
3434

35-
There are several Auth email templates which can be configured:
35+
There are several Auth email templates which can be configured. Each template serves a specific authentication flow:
3636

37-
- `auth.email.template.invite`
38-
- `auth.email.template.confirmation`
39-
- `auth.email.template.recovery`
40-
- `auth.email.template.magic_link`
41-
- `auth.email.template.email_change`
37+
### `auth.email.template.invite`
38+
39+
**Default subject**: "You have been invited"
40+
**When sent**: When a user is invited to join your application via email invitation
41+
**Purpose**: Allows administrators to invite users who don't have accounts yet
42+
**Content**: Contains a link for the invited user to accept the invitation and create their account
43+
44+
### `auth.email.template.confirmation`
45+
46+
**Default subject**: "Confirm Your Signup"
47+
**When sent**: When a user signs up and needs to verify their email address
48+
**Purpose**: Email verification for new user registrations
49+
**Content**: Contains a confirmation link to verify the user's email address
50+
51+
### `auth.email.template.recovery`
52+
53+
**Default subject**: "Reset Your Password"
54+
**When sent**: When a user requests a password reset
55+
**Purpose**: Password recovery flow for users who forgot their password
56+
**Content**: Contains a link to reset the user's password
57+
58+
### `auth.email.template.magic_link`
59+
60+
**Default subject**: "Your Magic Link"
61+
**When sent**: When a user requests a magic link for passwordless authentication
62+
**Purpose**: Passwordless login using email links
63+
**Content**: Contains a secure link that automatically logs the user in when clicked
64+
65+
### `auth.email.template.email_change`
66+
67+
**Default subject**: "Confirm Email Change"
68+
**When sent**: When a user requests to change their email address
69+
**Purpose**: Verification for email address changes
70+
**Content**: Contains a confirmation link to verify the new email address
71+
72+
### `auth.email.template.reauthentication`
73+
74+
**Default subject**: "Confirm Reauthentication"
75+
**When sent**: When a user needs to re-authenticate for sensitive operations
76+
**Purpose**: Additional verification for sensitive actions (like changing password, deleting account)
77+
**Content**: Contains a 6-digit OTP code for verification
4278

4379
## Template variables
4480

0 commit comments

Comments
 (0)