providers/email

Functions

default()

TODO:

Signature

default(config: EmailConfig): EmailConfig;

Parameters

Name	Type
config	EmailConfig

Returns

EmailConfig

Interfaces

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:

• Postmark
• Mailgun
• SendGrid
• etc.

See

Custom email service with Auth.js

Properties

id

string

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

Inherited from: CommonProviderOptions.id

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

Function

Type declaration

Documentation

####### Signature

(params: SendVerificationRequestParams): Awaitable<void>;

####### Parameters

Name	Type
params	SendVerificationRequestParams

####### Returns

Awaitable<void>

from?

string

Default

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

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

####### Signature

(): Awaitable<string>;

####### Returns

Awaitable<string>

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?

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

####### Signature

(identifier: string): string;

####### Parameters

Name	Type
identifier	string

####### Returns

string

secret?

string

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