Customizing email templates
Customizing local email templates using config.toml.
You can customize the email templates for local development using the config.toml
settings.
Configuring templates
You should provide a relative URL to the content_path
parameter, pointing to an HTML file which contains the template. For example
Available email templates
There are several Auth email templates which can be configured:
auth.email.template.invite
auth.email.template.confirmation
auth.email.template.recovery
auth.email.template.magic_link
auth.email.template.email_change
Template variables
The templating system provides the following variables for use:
ConfirmationURL
Contains the confirmation URL. For example, a signup confirmation URL would look like:
_10https://project-ref.supabase.co/auth/v1/verify?token={{ .TokenHash }}&type=signup&redirect_to=https://example.com/path
Usage
_10<p>Click here to confirm: {{ .ConfirmationURL }}</p>
Token
Contains a 6-digit One-Time-Password (OTP) that can be used instead of the ConfirmationURL
.
Usage
_10<p>Here is your one time password: {{ .Token }}</p>
TokenHash
Contains a hashed version of the Token
. This is useful for constructing your own email link in the email template.
Usage
_10<p>Follow this link to confirm your user:</p>_10<p>_10 <a href="{{ .SiteURL }}/auth/confirm?token_hash={{ .TokenHash }}&type=email"_10 >Confirm your email</a_10 >_10</p>
SiteURL
Contains your application's Site URL. This can be configured in your project's authentication settings.
Usage
_10<p>Visit <a href="{{ .SiteURL }}">here</a> to log in.</p>
Contains the user's email address.
Usage
_10<p>A recovery request was sent to {{ .Email }}.</p>
NewEmail
Contains the new user's email address. This is only available in the email_change
email template.
Usage
_10<p>You are requesting to update your email address to {{ .NewEmail }}.</p>
Deploying email templates
These settings are for local development. To apply the changes locally, stop and restart the Supabase containers:
_10supabase stop && supabase start
For hosted projects managed by Supabase, copy the templates into the Email Templates section of the Dashboard.