Skip to content

Commit d419131

Browse files
authored
Edit for Customize Email section (#426)
1 parent 0445abd commit d419131

39 files changed

+1371
-2555
lines changed

main/docs.json

Lines changed: 98 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1244,42 +1244,40 @@
12441244
"group": "Customize Emails",
12451245
"pages": [
12461246
"docs/customize/email",
1247-
"docs/customize/email/manage-email-flow",
1248-
{
1249-
"group": "Email Templates",
1250-
"pages": [
1251-
"docs/customize/email/email-templates",
1252-
"docs/customize/email/email-templates/use-liquid-syntax-in-email-templates",
1253-
"docs/customize/email/email-templates/email-template-descriptions"
1254-
]
1255-
},
12561247
{
1257-
"group": "Configure a Custom Email Provider",
1248+
"group": "SMTP Email Providers",
12581249
"pages": [
1259-
"docs/customize/email/configure-a-custom-email-provider",
1260-
"docs/customize/email/configure-a-custom-email-provider/configure-a-custom-email-provider-with-terraform",
1261-
"docs/customize/email/configure-a-custom-email-provider/action-triggers-custom-email-provider-event-object",
1262-
"docs/customize/email/configure-a-custom-email-provider/action-triggers-custom-email-provider-api-object"
1250+
"docs/customize/email/smtp-email-providers",
1251+
"docs/customize/email/smtp-email-providers/amazon-ses",
1252+
"docs/customize/email/smtp-email-providers/azure-communication-services",
1253+
"docs/customize/email/smtp-email-providers/mailgun",
1254+
"docs/customize/email/smtp-email-providers/mandrill",
1255+
"docs/customize/email/smtp-email-providers/microsoft-365-exchange-online",
1256+
"docs/customize/email/smtp-email-providers/sendgrid",
1257+
"docs/customize/email/smtp-email-providers/sparkpost",
1258+
"docs/customize/email/smtp-email-providers/smtp-server",
1259+
{
1260+
"group": "Custom Configuration with Actions",
1261+
"pages": [
1262+
"docs/customize/email/smtp-email-providers/custom",
1263+
"docs/customize/email/smtp-email-providers/custom/configure-action",
1264+
"docs/customize/email/smtp-email-providers/custom/action-triggers-custom-email-provider-event-object",
1265+
"docs/customize/email/smtp-email-providers/custom/action-triggers-custom-email-provider-api-object"
1266+
]
1267+
},
1268+
"docs/customize/email/smtp-email-providers/troubleshooting"
12631269
]
12641270
},
1265-
"docs/customize/email/customize-blocked-account-emails",
1266-
"docs/customize/email/send-email-invitations-for-application-signup",
12671271
{
1268-
"group": "SMTP Email Providers",
1272+
"group": "Email Templates",
12691273
"pages": [
1270-
"docs/customize/email/smtp-email-providers",
1271-
"docs/customize/email/smtp-email-providers/configure-amazon-ses-as-external-smtp-email-provider",
1272-
"docs/customize/email/smtp-email-providers/configure-azure-comm-service-as-smtp-email-provider",
1273-
"docs/customize/email/smtp-email-providers/configure-mandrill-as-external-smtp-email-provider",
1274-
"docs/customize/email/smtp-email-providers/configure-365-exchange-as-smtp-email-provider",
1275-
"docs/customize/email/smtp-email-providers/configure-sendgrid-as-external-smtp-email-provider",
1276-
"docs/customize/email/smtp-email-providers/configure-sparkpost-as-external-smtp-email-provider",
1277-
"docs/customize/email/smtp-email-providers/configure-mailgun-as-external-smtp-email-provider",
1278-
"docs/customize/email/smtp-email-providers/configure-custom-external-smtp-email-provider"
1274+
"docs/customize/email/email-templates",
1275+
"docs/customize/email/email-templates/customize-email-templates",
1276+
"docs/customize/email/email-templates/supported-liquid-syntax"
12791277
]
12801278
},
1281-
"docs/customize/email/configure-test-smtp-email-servers",
1282-
"docs/customize/email/troubleshoot-custom-email-provider-delivery-issues"
1279+
"docs/customize/email/manage-email-flow",
1280+
"docs/customize/email/send-email-invitations-for-application-signup"
12831281
]
12841282
},
12851283
{
@@ -7621,6 +7619,78 @@
76217619
]
76227620
},
76237621
"redirects": [
7622+
{
7623+
"source": "/docs/customize/email/email-templates/use-liquid-syntax-in-email-templates",
7624+
"destination": "/docs/customize/email/email-templates/supported-liquid-syntax"
7625+
},
7626+
{
7627+
"source": "/docs/customize/email/email-templates/email-template-descriptions",
7628+
"destination": "/docs/customize/email/email-templates"
7629+
},
7630+
{
7631+
"source": "/docs/customize/email/configure-a-custom-email-provider",
7632+
"destination": "/docs/customize/email/smtp-email-providers/custom"
7633+
},
7634+
{
7635+
"source": "/docs/customize/email/configure-a-custom-email-provider/configure-a-custom-email-provider-with-terraform",
7636+
"destination": "/docs/customize/email/smtp-email-providers/custom/configure-action"
7637+
},
7638+
{
7639+
"source": "/docs/customize/email/configure-a-custom-email-provider/action-triggers-custom-email-provider-event-object",
7640+
"destination": "/docs/customize/email/smtp-email-providers/custom/action-triggers-custom-email-provider-event-object"
7641+
},
7642+
{
7643+
"source": "/docs/customize/email/configure-a-custom-email-provider/action-triggers-custom-email-provider-api-object",
7644+
"destination": "/docs/customize/email/smtp-email-providers/custom/action-triggers-custom-email-provider-api-object"
7645+
},
7646+
{
7647+
"source": "/docs/customize/email/customize-blocked-account-emails",
7648+
"destination": "/docs/customize/email/email-templates/customize-email-templates"
7649+
},
7650+
{
7651+
"source": "docs/customize/email/smtp-email-providers/configure-amazon-ses-as-external-smtp-email-provider",
7652+
"destination": "/docs/customize/email/smtp-email-providers/amazon-ses"
7653+
},
7654+
{
7655+
"source": "docs/customize/email/smtp-email-providers/configure-azure-comm-service-as-smtp-email-provider",
7656+
"destination": "/docs/customize/email/smtp-email-providers/azure-communication-services"
7657+
},
7658+
{
7659+
"source": "docs/customize/email/smtp-email-providers/configure-mandrill-as-external-smtp-email-provider",
7660+
"destination": "/docs/customize/email/smtp-email-providers/mandrill"
7661+
},
7662+
{
7663+
"source": "docs/customize/email/smtp-email-providers/configure-365-exchange-as-smtp-email-provider",
7664+
"destination": "/docs/customize/email/smtp-email-providers/microsoft-365-exchange-online"
7665+
},
7666+
{
7667+
"source": "docs/customize/email/smtp-email-providers/configure-sendgrid-as-external-smtp-email-provider",
7668+
"destination": "/docs/customize/email/smtp-email-providers/sendgrid"
7669+
},
7670+
{
7671+
"source": "docs/customize/email/smtp-email-providers/configure-sparkpost-as-external-smtp-email-provider",
7672+
"destination": "/docs/customize/email/smtp-email-providers/sparkpost"
7673+
},
7674+
{
7675+
"source": "docs/customize/email/smtp-email-providers/configure-mailgun-as-external-smtp-email-provider",
7676+
"destination": "/docs/customize/email/smtp-email-providers/mailgun"
7677+
},
7678+
{
7679+
"source": "docs/customize/email/smtp-email-providers/configure-custom-external-smtp-email-provider",
7680+
"destination": "/docs/customize/email/smtp-email-providers/smtp-server"
7681+
},
7682+
{
7683+
"source": "/docs/customize/email/configure-test-smtp-email-servers",
7684+
"destination": "/docs/customize/email/smtp-email-providers"
7685+
},
7686+
{
7687+
"source": "/docs/customize/email/troubleshoot-custom-email-provider-delivery-issues",
7688+
"destination": "/docs/customize/email/smtp-email-providers/troubleshooting"
7689+
},
7690+
{
7691+
"source": "/docs/customize/custom-domains/self-managed-certificates/configure-akamai-for-use-as-reverse-proxy",
7692+
"destination": "/docs/customize/custom-domains/self-managed-certificates"
7693+
},
76247694
{
76257695
"source": "/docs/get-started/auth-for-genai",
76267696
"destination": "/docs/get-started/auth0-for-ai-agents"

main/docs/customize/email.mdx

Lines changed: 17 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,29 @@
11
---
2-
description: Describes the Auth0 built-in email services.
3-
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
4-
'og:title': Customize Emails
5-
'og:url': https://auth0.com/docs/
6-
permalink: email
7-
sidebarTitle: Overview
82
title: Customize Emails
9-
'twitter:description': Describes the Auth0 built-in email services.
10-
'twitter:title': Customize Emails
3+
sidebarTitle: Overview
4+
description: Manage and customize emails sent by Auth0, including account verification, welcome messages, and breached password detection.
5+
'og:image': https://cdn2.auth0.com/docs/1.14553.0/img/share-image.png
116
---
12-
You can configure a test SMTP email server in your development or test environments to check for successful email delivery and view how emails you send appear to recipients prior to going to production. To learn more, read [Configure Test SMTP Email Server](/docs/customize/email/configure-test-smtp-email-servers).
13-
14-
Auth0's built-in email provider is **not supported for use in a production environment**, should only be used for testing, and has several restrictions:
157

16-
* You will not be able to use any of the email customization features. The content of the emails sent for testing will be restricted to the format of the existing templates.
17-
* All emails will be sent from a predefined **from address** (`[email protected]`).
18-
* You will be restricted to sending no more than 10 emails per minute, regardless of email type.
19-
* Your ability to send email from your tenant may be reduced (or even temporarily blocked) if your emails result in high bounce rates.
8+
Auth0 offers several email-based workflows, like [user account verification](/docs/manage-users/user-accounts/verify-emails) and [breached password detection](/docs/secure/attack-protection/breached-password-detection).
209

21-
To remove these restrictions, you must set up your own email provider. Some options are:
10+
To use these workflows, start by configuring an [external SMTP email provider](/docs/customize/email/smtp-email-providers) using credentials from a supported provider (like your Mandrill API key or Amazon SES access keys) or SMTP server details.
2211

23-
* [Configure External SMTP Email Providers](/docs/customize/email/smtp-email-providers)
24-
* [Configure Custom External SMTP Email Providers](/docs/customize/email/smtp-email-providers/configure-custom-external-smtp-email-provider)
25-
* [Customize Email Handling](/docs/customize/email/manage-email-flow)
12+
To manage and customize emails further, you can:
2613

27-
After you have configured your own email service provider, go to [Dashboard > Branding > Email Templates](https://manage.auth0.com/#/emails) to [customize your emails](/docs/customize/email/email-templates). If you have an Auth0 database connection, there are several email templates you can use as part of the authentication flow:
14+
* **Modify the appearance and content** of emails using [email templates](/docs/customize/email/email-templates) and Liquid, an open-source template language.
2815

29-
* Verification emails (using link or code)
30-
* Welcome emails
31-
* Enroll in <Tooltip tip="Multi-factor authentication (MFA): User authentication process that uses a factor in addition to username and password such as a code via SMS." cta="View Glossary" href="/docs/glossary?term=MFA">MFA</Tooltip> emails
32-
* Change password emails
33-
* Blocked account emails
34-
* Password breach alert emails
16+
* **Fully control the email delivery process** by writing an <Tooltip tip="Action: A Node.js function that executes at defined points during the Auth0 runtime." cta="View Glossary" href="/docs/glossary?term=Actions">Action</Tooltip> that sends requests to your email provider's API and implements custom logic for your use case.
3517

36-
You can restrict user signups to an application with user invitations as a provisioning workflow, either in conjunction with or as an alternative to self-provisioning. To learn more, read [Send Email Invitations for Application Signup](/docs/customize/email/send-email-invitations-for-application-signup).
18+
* **Trigger emails or create tickets outside the default workflows** using the Management API.
3719

38-
A paid subscription plan is required for email customization. To learn more, read [Auth0 Pricing Page](https://auth0.com/pricing).
20+
During development, you can use our [built-in email provider](/docs/customize/email/smtp-email-providers#use-the-built-in-smtp-email-provider-for-development) to check email delivery and preview how emails appear during testing.
3921

40-
## Learn more
22+
## Overview
4123

42-
* [Customize Email Handling](/docs/customize/email/manage-email-flow)
43-
* [Customize Email Templates](/docs/customize/email/email-templates)
44-
* [Set Up Database Connections](/docs/get-started/applications/set-up-database-connections)
45-
* [Configure External SMTP Email Providers](/docs/customize/email/smtp-email-providers)
46-
* [Configure Test SMTP Email Server](/docs/customize/email/configure-test-smtp-email-servers)
47-
* [Customize Blocked Account Emails](/docs/customize/email/customize-blocked-account-emails)
24+
| Read... | To learn... |
25+
| --------|------------ |
26+
| [SMTP Email Providers](/docs/customize/email/smtp-email-providers) | <ul><li>How to configure an email provider with a supported integration or SMTP server details</li><li>How to write a custom email provider Action</li><li>The limits of the built-in email provider</li><li>How to troubleshoot email delivery issues</li></ul> |
27+
| [Email Templates](/docs/customize/email/email-templates) | <ul><li>How to customize emails sent as part of Auth0 workflows</li> <li>About the Liquid syntax and template-specific variables supported in email templates</li></ul>|
28+
| [Customize Email and Ticket Handling with the Management API](/docs/customize/email/manage-email-flow) | <ul><li>How to send workflow-based emails on demand</li><li>How to generate URLs used in email workflows on demand</li></ul> |
29+
| [Implement User Invitations using Password Reset Emails](/docs/customize/email/send-email-invitations-for-application-signup) | <ul><li>How to implement invitations for new user accounts on your Auth0 application using Auth0's password reset workflow</li></ul> |

0 commit comments

Comments
 (0)