--- title: Email --- import { Required } from '@site/src/components/Tag'; import MultipleIdentitiesWarning from './\_multiple-identities-warning.md'; import ReadMoreAboutAuthEntities from './\_read-more-about-auth-entities.md'; import GetEmail from './entities/\_get-email.md'; import UserSignupFieldsExplainer from './\_user-signup-fields-explainer.md'; import UserFields from './\_user-fields.md'; Wasp supports e-mail authentication out of the box, along with email verification and "forgot your password?" flows. It provides you with the server-side implementation and email templates for all of these flows. ![Auth UI](/img/authui/all_screens.gif) ## Setting Up Email Authentication We'll need to take the following steps to set up email authentication: 1. Enable email authentication in the Wasp file 1. Add the `User` entity 1. Add the auth routes and pages 1. Use Auth UI components in our pages 1. Set up the email sender Structure of the `main.wasp` file we will end up with: ```wasp title="main.wasp" // Configuring e-mail authentication app myApp { auth: { ... } } // Defining User entity entity User { ... } // Defining routes and pages route SignupRoute { ... } page SignupPage { ... } // ... ``` ### 1. Enable Email Authentication in `main.wasp` Let's start with adding the following to our `main.wasp` file: ```wasp title="main.wasp" app myApp { wasp: { version: "^0.13.0" }, title: "My App", auth: { // 1. Specify the user entity (we'll define it next) userEntity: User, methods: { // 2. Enable email authentication email: { // 3. Specify the email from field fromField: { name: "My App Postman", email: "hello@itsme.com" }, // 4. Specify the email verification and password reset options (we'll talk about them later) emailVerification: { clientRoute: EmailVerificationRoute, }, passwordReset: { clientRoute: PasswordResetRoute, }, }, }, onAuthFailedRedirectTo: "/login", onAuthSucceededRedirectTo: "/" }, } ``` ```wasp title="main.wasp" app myApp { wasp: { version: "^0.13.0" }, title: "My App", auth: { // 1. Specify the user entity (we'll define it next) userEntity: User, methods: { // 2. Enable email authentication email: { // 3. Specify the email from field fromField: { name: "My App Postman", email: "hello@itsme.com" }, // 4. Specify the email verification and password reset options (we'll talk about them later) emailVerification: { clientRoute: EmailVerificationRoute, }, passwordReset: { clientRoute: PasswordResetRoute, }, }, }, onAuthFailedRedirectTo: "/login", onAuthSucceededRedirectTo: "/" }, } ``` Read more about the `email` auth method options [here](#fields-in-the-email-dict). ### 2. Add the User Entity The `User` entity can be as simple as including only the `id` field: ```wasp title="main.wasp" // 5. Define the user entity entity User {=psl // highlight-next-line id Int @id @default(autoincrement()) // Add your own fields below // ... psl=} ``` ```wasp title="main.wasp" // 5. Define the user entity entity User {=psl // highlight-next-line id Int @id @default(autoincrement()) // Add your own fields below // ... psl=} ``` ### 3. Add the Routes and Pages Next, we need to define the routes and pages for the authentication pages. Add the following to the `main.wasp` file: ```wasp title="main.wasp" // ... // 6. Define the routes route LoginRoute { path: "/login", to: LoginPage } page LoginPage { component: import { Login } from "@src/pages/auth.jsx" } route SignupRoute { path: "/signup", to: SignupPage } page SignupPage { component: import { Signup } from "@src/pages/auth.jsx" } route RequestPasswordResetRoute { path: "/request-password-reset", to: RequestPasswordResetPage } page RequestPasswordResetPage { component: import { RequestPasswordReset } from "@src/pages/auth.jsx", } route PasswordResetRoute { path: "/password-reset", to: PasswordResetPage } page PasswordResetPage { component: import { PasswordReset } from "@src/pages/auth.jsx", } route EmailVerificationRoute { path: "/email-verification", to: EmailVerificationPage } page EmailVerificationPage { component: import { EmailVerification } from "@src/pages/auth.jsx", } ``` ```wasp title="main.wasp" // ... // 6. Define the routes route LoginRoute { path: "/login", to: LoginPage } page LoginPage { component: import { Login } from "@src/pages/auth.tsx" } route SignupRoute { path: "/signup", to: SignupPage } page SignupPage { component: import { Signup } from "@src/pages/auth.tsx" } route RequestPasswordResetRoute { path: "/request-password-reset", to: RequestPasswordResetPage } page RequestPasswordResetPage { component: import { RequestPasswordReset } from "@src/pages/auth.tsx", } route PasswordResetRoute { path: "/password-reset", to: PasswordResetPage } page PasswordResetPage { component: import { PasswordReset } from "@src/pages/auth.tsx", } route EmailVerificationRoute { path: "/email-verification", to: EmailVerificationPage } page EmailVerificationPage { component: import { EmailVerification } from "@src/pages/auth.tsx", } ``` We'll define the React components for these pages in the `src/pages/auth.{jsx,tsx}` file below. ### 4. Create the Client Pages :::info We are using [Tailwind CSS](https://tailwindcss.com/) to style the pages. Read more about how to add it [here](../project/css-frameworks). ::: Let's create a `auth.{jsx,tsx}` file in the `src/pages` folder and add the following to it: ```tsx title="src/pages/auth.jsx" import { LoginForm, SignupForm, VerifyEmailForm, ForgotPasswordForm, ResetPasswordForm, } from 'wasp/client/auth' import { Link } from 'react-router-dom' export function Login() { return (
Don't have an account yet? go to signup.
Forgot your password? reset it .
); } export function Signup() { return (
I already have an account (go to login).
); } export function EmailVerification() { return (
If everything is okay, go to login
); } export function RequestPasswordReset() { return ( ); } export function PasswordReset() { return (
If everything is okay, go to login
); } // A layout component to center the content export function Layout({ children }) { return (
{children}
); } ```
```tsx title="src/pages/auth.tsx" import { LoginForm, SignupForm, VerifyEmailForm, ForgotPasswordForm, ResetPasswordForm, } from 'wasp/client/auth' import { Link } from 'react-router-dom' export function Login() { return (
Don't have an account yet? go to signup.
Forgot your password? reset it .
); } export function Signup() { return (
I already have an account (go to login).
); } export function EmailVerification() { return (
If everything is okay, go to login
); } export function RequestPasswordReset() { return ( ); } export function PasswordReset() { return (
If everything is okay, go to login
); } // A layout component to center the content export function Layout({ children }: { children: React.ReactNode }) { return (
{children}
); } ```
We imported the generated Auth UI components and used them in our pages. Read more about the Auth UI components [here](../auth/ui). ### 5. Set up an Email Sender To support e-mail verification and password reset flows, we need an e-mail sender. Luckily, Wasp supports several email providers out of the box. We'll use the `Dummy` provider to speed up the setup. It just logs the emails to the console instead of sending them. You can use any of the [supported email providers](../advanced/email#providers). To set up the `Dummy` provider to send emails, add the following to the `main.wasp` file: ```wasp title="main.wasp" app myApp { // ... // 7. Set up the email sender emailSender: { provider: Dummy, } } ``` ```wasp title="main.wasp" app myApp { // ... // 7. Set up the email sender emailSender: { provider: Dummy, } } ``` ### Conclusion That's it! We have set up email authentication in our app. 🎉 Running `wasp db migrate-dev` and then `wasp start` should give you a working app with email authentication. If you want to put some of the pages behind authentication, read the [auth overview](../auth/overview). ## Login and Signup Flows ### Login ![Auth UI](/img/authui/login.png) ### Signup ![Auth UI](/img/authui/signup.png) Some of the behavior you get out of the box: 1. Rate limiting We are limiting the rate of sign-up requests to **1 request per minute** per email address. This is done to prevent spamming. 2. Preventing user email leaks If somebody tries to signup with an email that already exists and it's verified, we _pretend_ that the account was created instead of saying it's an existing account. This is done to prevent leaking the user's email address. 3. Allowing registration for unverified emails If a user tries to register with an existing but **unverified** email, we'll allow them to do that. This is done to prevent bad actors from locking out other users from registering with their email address. 4. Password validation Read more about the default password validation rules and how to override them in [auth overview docs](../auth/overview). ## Email Verification Flow :::info Automatic email verification in development In development mode, you can skip the email verification step by setting the `SKIP_EMAIL_VERIFICATION_IN_DEV` environment variable to `true` in your `.env.server` file: ```env title=".env.server" SKIP_EMAIL_VERIFICATION_IN_DEV=true ``` This is useful when you are developing your app and don't want to go through the email verification flow every time you sign up. It can be also useful when you are writing automated tests for your app. ::: By default, Wasp requires the e-mail to be verified before allowing the user to log in. This is done by sending a verification email to the user's email address and requiring the user to click on a link in the email to verify their email address. Our setup looks like this: ```wasp title="main.wasp" // ... emailVerification: { clientRoute: EmailVerificationRoute, } ``` ```wasp title="main.wasp" // ... emailVerification: { clientRoute: EmailVerificationRoute, } ``` When the user receives an e-mail, they receive a link that goes to the client route specified in the `clientRoute` field. In our case, this is the `EmailVerificationRoute` route we defined in the `main.wasp` file. The content of the e-mail can be customized, read more about it [here](#emailverification-emailverificationconfig-). ### Email Verification Page We defined our email verification page in the `auth.{jsx,tsx}` file. ![Auth UI](/img/authui/email_verification.png) ## Password Reset Flow Users can request a password and then they'll receive an e-mail with a link to reset their password. Some of the behavior you get out of the box: 1. Rate limiting We are limiting the rate of sign-up requests to **1 request per minute** per email address. This is done to prevent spamming. 2. Preventing user email leaks If somebody requests a password reset with an unknown email address, we'll give back the same response as if the user requested a password reset successfully. This is done to prevent leaking information. Our setup in `main.wasp` looks like this: ```wasp title="main.wasp" // ... passwordReset: { clientRoute: PasswordResetRoute, } ``` ```wasp title="main.wasp" // ... passwordReset: { clientRoute: PasswordResetRoute, } ``` ### Request Password Reset Page Users request their password to be reset by going to the `/request-password-reset` route. We defined our request password reset page in the `auth.{jsx,tsx}` file. ![Request password reset page](/img/authui/forgot_password_after.png) ### Password Reset Page When the user receives an e-mail, they receive a link that goes to the client route specified in the `clientRoute` field. In our case, this is the `PasswordResetRoute` route we defined in the `main.wasp` file. ![Request password reset page](/img/authui/reset_password_after.png) Users can enter their new password there. The content of the e-mail can be customized, read more about it [here](#passwordreset-passwordresetconfig-). ## Creating a Custom Sign-up Action :::caution Creating a custom sign-up action We don't recommend creating a custom sign-up action unless you have a good reason to do so. It is a complex process and you can easily make a mistake that will compromise the security of your app. ::: The code of your custom sign-up action can look like this: ```wasp title="main.wasp" // ... action customSignup { fn: import { signup } from "@src/auth/signup.js", } ``` ```js title="src/auth/signup.js" import { ensurePasswordIsPresent, ensureValidPassword, ensureValidEmail, createProviderId, sanitizeAndSerializeProviderData, deserializeAndSanitizeProviderData, findAuthIdentity, createUser, createEmailVerificationLink, sendEmailVerificationEmail, } from 'wasp/server/auth' export const signup = async (args, _context) => { ensureValidEmail(args) ensurePasswordIsPresent(args) ensureValidPassword(args) try { const providerId = createProviderId('email', args.email) const existingAuthIdentity = await findAuthIdentity(providerId) if (existingAuthIdentity) { const providerData = deserializeAndSanitizeProviderData(existingAuthIdentity.providerData) // Your custom code here } else { // sanitizeAndSerializeProviderData will hash the user's password const newUserProviderData = await sanitizeAndSerializeProviderData({ hashedPassword: args.password, isEmailVerified: false, emailVerificationSentAt: null, passwordResetSentAt: null, }) await createUser( providerId, providerData, // Any additional data you want to store on the User entity {}, ) // Verification link links to a client route e.g. /email-verification const verificationLink = await createEmailVerificationLink(args.email, '/email-verification'); try { await sendEmailVerificationEmail( args.email, { from: { name: "My App Postman", email: "hello@itsme.com", }, to: args.email, subject: "Verify your email", text: `Click the link below to verify your email: ${verificationLink}`, html: `

Click the link below to verify your email

Verify email `, } ); } catch (e: unknown) { console.error("Failed to send email verification email:", e); throw new HttpError(500, "Failed to send email verification email."); } } } catch (e) { return { success: false, message: e.message, } } // Your custom code after sign-up. // ... return { success: true, message: 'User created successfully', } } ```
```wasp title="main.wasp" // ... action customSignup { fn: import { signup } from "@src/auth/signup.js", } ``` ```ts title="src/auth/signup.ts" import { ensurePasswordIsPresent, ensureValidPassword, ensureValidEmail, createProviderId, sanitizeAndSerializeProviderData, deserializeAndSanitizeProviderData, findAuthIdentity, createUser, createEmailVerificationLink, sendEmailVerificationEmail, } from 'wasp/server/auth' import type { CustomSignup } from 'wasp/server/operations' type CustomSignupInput = { email: string password: string } type CustomSignupOutput = { success: boolean message: string } export const signup: CustomSignup = async (args, _context) => { ensureValidEmail(args) ensurePasswordIsPresent(args) ensureValidPassword(args) try { const providerId = createProviderId('email', args.email) const existingAuthIdentity = await findAuthIdentity(providerId) if (existingAuthIdentity) { const providerData = deserializeAndSanitizeProviderData<'email'>(existingAuthIdentity.providerData) // Your custom code here } else { // sanitizeAndSerializeProviderData will hash the user's password const newUserProviderData = await sanitizeAndSerializeProviderData<'email'>({ hashedPassword: args.password, isEmailVerified: false, emailVerificationSentAt: null, passwordResetSentAt: null, }) await createUser( providerId, providerData, // Any additional data you want to store on the User entity {}, ) // Verification link links to a client route e.g. /email-verification const verificationLink = await createEmailVerificationLink(args.email, '/email-verification'); try { await sendEmailVerificationEmail( args.email, { from: { name: "My App Postman", email: "hello@itsme.com", }, to: args.email, subject: "Verify your email", text: `Click the link below to verify your email: ${verificationLink}`, html: `

Click the link below to verify your email

Verify email `, } ); } catch (e: unknown) { console.error("Failed to send email verification email:", e); throw new HttpError(500, "Failed to send email verification email."); } } } catch (e) { return { success: false, message: e.message, } } // Your custom code after sign-up. // ... return { success: true, message: 'User created successfully', } } ```
We suggest using the built-in field validators for your authentication flow. You can import them from `wasp/server/auth`. These are the same validators that Wasp uses internally for the default authentication flow. #### Email - `ensureValidEmail(args)` Checks if the email is valid and throws an error if it's not. Read more about the validation rules [here](../auth/overview#default-validations). #### Password - `ensurePasswordIsPresent(args)` Checks if the password is present and throws an error if it's not. - `ensureValidPassword(args)` Checks if the password is valid and throws an error if it's not. Read more about the validation rules [here](../auth/overview#default-validations). ## Using Auth To read more about how to set up the logout button and how to get access to the logged-in user in our client and server code, read the [auth overview docs](../auth/overview). ### `getEmail` If you are looking to access the user's email in your code, you can do that by accessing the info about the user that is stored in the `user.auth.identities` array. To make things a bit easier for you, Wasp offers the `getEmail` helper. ## API Reference Let's go over the options we can specify when using email authentication. ### `userEntity` fields ```wasp title="main.wasp" app myApp { title: "My app", // ... auth: { userEntity: User, methods: { email: { // We'll explain these options below }, }, onAuthFailedRedirectTo: "/someRoute" }, // ... } entity User {=psl // highlight-next-line id Int @id @default(autoincrement()) psl=} ``` ```wasp title="main.wasp" app myApp { title: "My app", // ... auth: { userEntity: User, methods: { email: { // We'll explain these options below }, }, onAuthFailedRedirectTo: "/someRoute" }, // ... } entity User {=psl // highlight-next-line id Int @id @default(autoincrement()) psl=} ``` ### Fields in the `email` dict ```wasp title="main.wasp" app myApp { title: "My app", // ... auth: { userEntity: User, methods: { email: { userSignupFields: import { userSignupFields } from "@src/auth.js", fromField: { name: "My App", email: "hello@itsme.com" }, emailVerification: { clientRoute: EmailVerificationRoute, getEmailContentFn: import { getVerificationEmailContent } from "@src/auth/email.js", }, passwordReset: { clientRoute: PasswordResetRoute, getEmailContentFn: import { getPasswordResetEmailContent } from "@src/auth/email.js", }, }, }, onAuthFailedRedirectTo: "/someRoute" }, // ... } ``` ```wasp title="main.wasp" app myApp { title: "My app", // ... auth: { userEntity: User, methods: { email: { userSignupFields: import { userSignupFields } from "@src/auth.js", fromField: { name: "My App", email: "hello@itsme.com" }, emailVerification: { clientRoute: EmailVerificationRoute, getEmailContentFn: import { getVerificationEmailContent } from "@src/auth/email.js", }, passwordReset: { clientRoute: PasswordResetRoute, getEmailContentFn: import { getPasswordResetEmailContent } from "@src/auth/email.js", }, }, }, onAuthFailedRedirectTo: "/someRoute" }, // ... } ``` #### `userSignupFields: ExtImport` Read more about the `userSignupFields` function [here](./overview#1-defining-extra-fields). #### `fromField: EmailFromField` `fromField` is a dict that specifies the name and e-mail address of the sender of the e-mails sent by your app. It has the following fields: - `name`: name of the sender - `email`: e-mail address of the sender #### `emailVerification: EmailVerificationConfig` `emailVerification` is a dict that specifies the details of the e-mail verification process. It has the following fields: - `clientRoute: Route`: a route that is used for the user to verify their e-mail address. Client route should handle the process of taking a token from the URL and sending it to the server to verify the e-mail address. You can use our `verifyEmail` action for that. ```js title="src/pages/EmailVerificationPage.jsx" import { verifyEmail } from 'wasp/client/auth' ... await verifyEmail({ token }); ``` ```ts title="src/pages/EmailVerificationPage.tsx" import { verifyEmail } from 'wasp/client/auth' ... await verifyEmail({ token }); ``` :::note We used Auth UI above to avoid doing this work of sending the token to the server manually. ::: - `getEmailContentFn: ExtImport`: a function that returns the content of the e-mail that is sent to the user. Defining `getEmailContentFn` can be done by defining a file in the `src` directory. ```ts title="src/email.js" export const getVerificationEmailContent = ({ verificationLink }) => ({ subject: 'Verify your email', text: `Click the link below to verify your email: ${verificationLink}`, html: `

Click the link below to verify your email

Verify email `, }) ```
```ts title="src/email.ts" import { GetVerificationEmailContentFn } from 'wasp/server/auth' export const getVerificationEmailContent: GetVerificationEmailContentFn = ({ verificationLink, }) => ({ subject: 'Verify your email', text: `Click the link below to verify your email: ${verificationLink}`, html: `

Click the link below to verify your email

Verify email `, }) ```
This is the default content of the e-mail, you can customize it to your liking. #### `passwordReset: PasswordResetConfig` `passwordReset` is a dict that specifies the password reset process. It has the following fields: - `clientRoute: Route`: a route that is used for the user to reset their password. Client route should handle the process of taking a token from the URL and a new password from the user and sending it to the server. You can use our `requestPasswordReset` and `resetPassword` actions to do that. ```js title="src/pages/ForgotPasswordPage.jsx" import { requestPasswordReset } from 'wasp/client/auth' ... await requestPasswordReset({ email }); ``` ```js title="src/pages/PasswordResetPage.jsx" import { resetPassword } from 'wasp/client/auth' ... await resetPassword({ password, token }) ``` ```ts title="src/pages/ForgotPasswordPage.tsx" import { requestPasswordReset } from 'wasp/client/auth' ... await requestPasswordReset({ email }); ``` ```ts title="src/pages/PasswordResetPage.tsx" import { resetPassword } from 'wasp/client/auth' ... await resetPassword({ password, token }) ``` :::note We used Auth UI above to avoid doing this work of sending the password request and the new password to the server manually. ::: - `getEmailContentFn: ExtImport`: a function that returns the content of the e-mail that is sent to the user. Defining `getEmailContentFn` is done by defining a function that looks like this: ```ts title="src/email.js" export const getPasswordResetEmailContent = ({ passwordResetLink }) => ({ subject: 'Password reset', text: `Click the link below to reset your password: ${passwordResetLink}`, html: `

Click the link below to reset your password

Reset password `, }) ```
```ts title="src/email.ts" import { GetPasswordResetEmailContentFn } from 'wasp/server/auth' export const getPasswordResetEmailContent: GetPasswordResetEmailContentFn = ({ passwordResetLink, }) => ({ subject: 'Password reset', text: `Click the link below to reset your password: ${passwordResetLink}`, html: `

Click the link below to reset your password

Reset password `, }) ```
This is the default content of the e-mail, you can customize it to your liking.