From df1bfb901788fc6a0059f29e511c2f6750c8b646 Mon Sep 17 00:00:00 2001 From: Joel Lee Date: Tue, 29 Oct 2024 17:09:29 +0800 Subject: [PATCH] fix: describe Auth Hook interaction with email provider (#30159) * fix: include table with email settings * fix: update terminology to Enabled/Disabled --- .../guides/auth/auth-hooks/send-email-hook.mdx | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/apps/docs/content/guides/auth/auth-hooks/send-email-hook.mdx b/apps/docs/content/guides/auth/auth-hooks/send-email-hook.mdx index eb268d8d25e..c6e2f30ab0b 100644 --- a/apps/docs/content/guides/auth/auth-hooks/send-email-hook.mdx +++ b/apps/docs/content/guides/auth/auth-hooks/send-email-hook.mdx @@ -6,6 +6,17 @@ subtitle: 'Use a custom email provider to send authentication messages' The Send Email Hook runs before an email is sent and allows for flexibility around email sending. You can use this hook to configure a back-up email provider or add internationalization to your emails. +## Email Sending Behavior + +Email sending depends on two settings: Email Provider and Auth Hook status. + +| Email Provider | Auth Hook | Result | +| -------------- | --------- | -------------------------------------------------------------------- | +| Enabled | Enabled | Auth Hook handles email sending (SMTP not used) | +| Enabled | Disabled | SMTP handles email sending (custom if configured, default otherwise) | +| Disabled | Enabled | Email Signups Disabled | +| Disabled | Disabled | Email Signups Disabled | + **Inputs** | Field | Type | Description |