Skip to content
Migrating from NextAuth.js v4? Read our migration guide.

providers/nodemailer

NodemailerConfig

Shared across all ProviderType

Extends

Properties

apiKey?

optional apiKey: string;

Used with HTTP-based email providers.

Inherited from

EmailConfig.apiKey

from?

optional from: string;
Inherited from

EmailConfig.from

generateVerificationToken()?

optional generateVerificationToken: () => Awaitable<string>;
Returns

Awaitable<string>

Inherited from

EmailConfig.generateVerificationToken

id

id: string;

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

Inherited from

EmailConfig.id

maxAge?

optional maxAge: number;
Inherited from

EmailConfig.maxAge

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

EmailConfig.name

normalizeIdentifier()?

optional normalizeIdentifier: (identifier) => string;
Parameters
ParameterType
identifierstring
Returns

string

Inherited from

EmailConfig.normalizeIdentifier

options?

optional options: NodemailerUserConfig;
Overrides

EmailConfig.options

secret?

optional secret: string;

Used to hash the verification token.

Inherited from

EmailConfig.secret

sendVerificationRequest()

sendVerificationRequest: (params) => Awaitable<void>;
Parameters
ParameterType
paramsObject
params.expiresDate
params.identifierstring
params.providerNodemailerConfig
params.requestRequest
params.themeTheme
params.tokenstring
params.urlstring
Returns

Awaitable<void>

Overrides

EmailConfig.sendVerificationRequest

server?

optional server: AllTransportOptions;

Used with SMTP-based email providers.

Overrides

EmailConfig.server

type

type: "email";

See ProviderType

Inherited from

EmailConfig.type


NodemailerUserConfig

type NodemailerUserConfig: Omit<Partial<NodemailerConfig>, "options" | "type">;

default()

default(config): NodemailerConfig

Parameters

ParameterType
configNodemailerUserConfig

Returns

NodemailerConfig

Auth.js © Balázs Orbán and Team - 2024