providers/nodemailer
NodemailerConfig
Shared across all ProviderType
Extends
Properties
apiKey?
optional apiKey: string;Used with HTTP-based email providers.
Inherited from
from?
optional from: string;Inherited 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
maxAge?
optional maxAge: number;Inherited from
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
normalizeIdentifier()?
optional normalizeIdentifier: (identifier) => string;Parameters
| Parameter | Type |
|---|---|
identifier | string |
Returns
string
Inherited from
EmailConfig.normalizeIdentifier
options?
optional options: NodemailerUserConfig;Overrides
secret?
optional secret: string;Used to hash the verification token.
Inherited from
sendVerificationRequest()
sendVerificationRequest: (params) => Awaitable<void>;Parameters
| Parameter | Type |
|---|---|
params | { expires: Date; identifier: string; provider: NodemailerConfig; request: Request; theme: Theme; token: string; url: string; } |
params.expires | Date |
params.identifier | string |
params.provider | NodemailerConfig |
params.request | Request |
params.theme | Theme |
params.token | string |
params.url | string |
Returns
Awaitable<void>
Overrides
EmailConfig.sendVerificationRequest
server?
optional server: AllTransportOptions;Used with SMTP-based email providers.
Overrides
type
type: "email";See ProviderType
Inherited from
NodemailerUserConfig
type NodemailerUserConfig = Omit<Partial<NodemailerConfig>, "options" | "type">;default()
function default(config): NodemailerConfigParameters
| Parameter | Type |
|---|---|
config | NodemailerUserConfig |