Skip to main content
Version: Next

Interface: EmailAuthConfig

Email auth configuration.

See the Email auth docs for the full signup, verification, and password reset flows.

Extends

  • BaseAuthMethodConfig

Properties

emailVerification

emailVerification: EmailFlowConfig

Email verification flow configuration.

Its clientRoute should handle the verification link sent to the user.


fromField

fromField: EmailFromField

Sender identity used for verification and password reset emails.


passwordReset

passwordReset: EmailFlowConfig

Password reset flow configuration.

Its clientRoute should handle the password reset link and the new password submitted by the user.


userSignupFields?

optional userSignupFields?: Reference<AnyObject>

Object that defines extra fields to save on the user during signup (e.g. firstName, address). Each field name must exist on the configured Auth.userEntity.

Each field function receives the data sent from the client and returns the value Wasp saves to the database. For social auth, this data includes provider-specific profile information. If the value is invalid, throw an error. The password field is excluded from this object and handled by Wasp's auth backend.

See Signup Fields Customization.

Inherited from

BaseAuthMethodConfig.userSignupFields