Skip to main content

providers/email

default()​

TODO:

default(config: EmailConfig): EmailConfig

Parameters​

ParameterType
configEmailConfig

Returns​

EmailConfig

EmailConfig​

The Email Provider needs to be configured with an e-mail client. By default, it uses nodemailer, which you have to install if this provider is present.

You can use a other services as well, like:

See​

Custom email service with Auth.js

Properties​

id​

id: string

Uniquely identifies the provider in AuthConfig.providers It's also part of the URL

Inherited from​

CommonProviderOptions.id

name​

name: string

The provider name used on the default sign-in page's sign-in button. For example if it's "Google", the corresponding button will say: "Sign in with Google"

Inherited from​

CommonProviderOptions.name

sendVerificationRequest​

sendVerificationRequest: Function

Type declaration​

Documentation

(params: SendVerificationRequestParams): Awaitable<void>

Parameters​
ParameterType
paramsSendVerificationRequestParams
Returns​

Awaitable<void>

from?​

from: string

Default​

"Auth.js <no-reply@authjs.dev>"

generateVerificationToken?​

generateVerificationToken: Function

Type declaration​

By default, we are generating a random verification token. You can make it predictable or modify it as you like with this method.

Example​
Providers.Email({
  async generateVerificationToken() {
    return "ABC123";
  },
});

Documentation

(): Awaitable<string>

Returns​

Awaitable<string>

maxAge?​

maxAge: number

How long until the e-mail can be used to log the user in, in seconds. Defaults to 1 day

Default​
86400;

normalizeIdentifier?​

normalizeIdentifier: Function

Type declaration​

Normalizes the user input before sending the verification request.

⚠️ Always make sure this method returns a single email address.

Note​

Technically, the part of the email address local mailbox element (everything before the @ symbol) should be treated as 'case sensitive' according to RFC 2821, but in practice this causes more problems than it solves, e.g.: when looking up users by e-mail from databases. By default, we treat email addresses as all lower case, but you can override this function to change this behavior.

Documentation | RFC 2821 | Email syntax

(identifier: string): string

Parameters​
ParameterType
identifierstring
Returns​

string

secret?​

secret: string

If defined, it is used to hash the verification token when saving to the database .