Skip to content
SuperTokens Docs
Esc
↑↓navigate↵open⌘Jpreview
Dashboard
On this page

supertokens-node/recipe/emailverification

References documentation for the supertokens-node/recipe/emailverification package

Classes

default

Defined in: recipe/emailverification/index.ts

Constructors

Constructor
new default(): default;
Returns

default

Properties

Property Modifier Type Default value Defined in
EmailVerificationClaim static EmailVerificationClaimClass EmailVerificationClaim recipe/emailverification/index.ts
Error static typeof default SuperTokensError recipe/emailverification/index.ts
init static (config) => RecipeListFunction Recipe.init recipe/emailverification/index.ts

Methods

static createEmailVerificationLink(
   tenantId, 
   recipeUserId, 
   email?, 
   userContext?): Promise<
  | {
  link: string;
  status: "OK";
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}>;

Defined in: recipe/emailverification/index.ts

Parameters
Parameter Type
tenantId string
recipeUserId RecipeUserId
email? string
userContext? Record<string, any>
Returns

Promise< | { link: string; status: "OK"; } | { status: "EMAIL_ALREADY_VERIFIED_ERROR"; }>

createEmailVerificationToken()
static createEmailVerificationToken(
   tenantId, 
   recipeUserId, 
   email?, 
   userContext?): Promise<
  | {
  status: "OK";
  token: string;
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}>;

Defined in: recipe/emailverification/index.ts

Parameters
Parameter Type
tenantId string
recipeUserId RecipeUserId
email? string
userContext? Record<string, any>
Returns

Promise< | { status: "OK"; token: string; } | { status: "EMAIL_ALREADY_VERIFIED_ERROR"; }>

isEmailVerified()
static isEmailVerified(
   recipeUserId, 
   email?, 
userContext?): Promise<boolean>;

Defined in: recipe/emailverification/index.ts

Parameters
Parameter Type
recipeUserId RecipeUserId
email? string
userContext? Record<string, any>
Returns

Promise<boolean>

revokeEmailVerificationTokens()
static revokeEmailVerificationTokens(
   tenantId, 
   recipeUserId, 
   email?, 
   userContext?): Promise<{
  status: string;
}>;

Defined in: recipe/emailverification/index.ts

Parameters
Parameter Type
tenantId string
recipeUserId RecipeUserId
email? string
userContext? Record<string, any>
Returns

Promise<{ status: string; }>

sendEmail()
static sendEmail(input): Promise<void>;

Defined in: recipe/emailverification/index.ts

Parameters
Parameter Type
input TypeEmailVerificationEmailDeliveryInput & object
Returns

Promise<void>

sendEmailVerificationEmail()
static sendEmailVerificationEmail(
   tenantId, 
   userId, 
   recipeUserId, 
   email?, 
   userContext?): Promise<
  | {
  status: "OK";
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}>;

Defined in: recipe/emailverification/index.ts

Parameters
Parameter Type
tenantId string
userId string
recipeUserId RecipeUserId
email? string
userContext? Record<string, any>
Returns

Promise< | { status: "OK"; } | { status: "EMAIL_ALREADY_VERIFIED_ERROR"; }>

unverifyEmail()
static unverifyEmail(
   recipeUserId, 
   email?, 
   userContext?): Promise<{
  status: string;
}>;

Defined in: recipe/emailverification/index.ts

Parameters
Parameter Type
recipeUserId RecipeUserId
email? string
userContext? Record<string, any>
Returns

Promise<{ status: string; }>

verifyEmailUsingToken()
static verifyEmailUsingToken(
   tenantId, 
   token, 
   attemptAccountLinking, 
   userContext?): Promise<
  | {
  status: "OK";
  user: UserEmailInfo;
}
  | {
  status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR";
}>;

Defined in: recipe/emailverification/index.ts

Parameters
Parameter Type Default value
tenantId string undefined
token string undefined
attemptAccountLinking boolean true
userContext? Record<string, any> undefined
Returns

Promise< | { status: "OK"; user: UserEmailInfo; } | { status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"; }>

Variables

createEmailVerificationLink: (tenantId, recipeUserId, email?, userContext?) => Promise<
  | {
  link: string;
  status: "OK";
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}> = Wrapper.createEmailVerificationLink;

Defined in: recipe/emailverification/index.ts

Parameters

Parameter Type
tenantId string
recipeUserId RecipeUserId
email? string
userContext? Record<string, any>

Returns

Promise< | { link: string; status: "OK"; } | { status: "EMAIL_ALREADY_VERIFIED_ERROR"; }>

createEmailVerificationToken()

createEmailVerificationToken: (tenantId, recipeUserId, email?, userContext?) => Promise<
  | {
  status: "OK";
  token: string;
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}> = Wrapper.createEmailVerificationToken;

Defined in: recipe/emailverification/index.ts

Parameters

Parameter Type
tenantId string
recipeUserId RecipeUserId
email? string
userContext? Record<string, any>

Returns

Promise< | { status: "OK"; token: string; } | { status: "EMAIL_ALREADY_VERIFIED_ERROR"; }>

EmailVerificationClaim

const EmailVerificationClaim: EmailVerificationClaimClass;

Defined in: recipe/emailverification/emailVerificationClaim.ts

Error

Error: typeof default = Wrapper.Error;

Defined in: recipe/emailverification/index.ts

init()

init: (config) => RecipeListFunction = Wrapper.init;

Defined in: recipe/emailverification/index.ts

Parameters

Parameter Type
config TypeInput

Returns

RecipeListFunction

isEmailVerified()

isEmailVerified: (recipeUserId, email?, userContext?) => Promise<boolean> = Wrapper.isEmailVerified;

Defined in: recipe/emailverification/index.ts

Parameters

Parameter Type
recipeUserId RecipeUserId
email? string
userContext? Record<string, any>

Returns

Promise<boolean>

revokeEmailVerificationTokens()

revokeEmailVerificationTokens: (tenantId, recipeUserId, email?, userContext?) => Promise<{
  status: string;
}> = Wrapper.revokeEmailVerificationTokens;

Defined in: recipe/emailverification/index.ts

Parameters

Parameter Type
tenantId string
recipeUserId RecipeUserId
email? string
userContext? Record<string, any>

Returns

Promise<{ status: string; }>

sendEmail()

sendEmail: (input) => Promise<void> = Wrapper.sendEmail;

Defined in: recipe/emailverification/index.ts

Parameters

Parameter Type
input TypeEmailVerificationEmailDeliveryInput & object

Returns

Promise<void>

sendEmailVerificationEmail()

sendEmailVerificationEmail: (tenantId, userId, recipeUserId, email?, userContext?) => Promise<
  | {
  status: "OK";
}
  | {
  status: "EMAIL_ALREADY_VERIFIED_ERROR";
}> = Wrapper.sendEmailVerificationEmail;

Defined in: recipe/emailverification/index.ts

Parameters

Parameter Type
tenantId string
userId string
recipeUserId RecipeUserId
email? string
userContext? Record<string, any>

Returns

Promise< | { status: "OK"; } | { status: "EMAIL_ALREADY_VERIFIED_ERROR"; }>

unverifyEmail()

unverifyEmail: (recipeUserId, email?, userContext?) => Promise<{
  status: string;
}> = Wrapper.unverifyEmail;

Defined in: recipe/emailverification/index.ts

Parameters

Parameter Type
recipeUserId RecipeUserId
email? string
userContext? Record<string, any>

Returns

Promise<{ status: string; }>

verifyEmailUsingToken()

verifyEmailUsingToken: (tenantId, token, attemptAccountLinking, userContext?) => Promise<
  | {
  status: "OK";
  user: UserEmailInfo;
}
  | {
  status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR";
}> = Wrapper.verifyEmailUsingToken;

Defined in: recipe/emailverification/index.ts

Parameters

Parameter Type Default value
tenantId string undefined
token string undefined
attemptAccountLinking boolean true
userContext? Record<string, any> undefined

Returns

Promise< | { status: "OK"; user: UserEmailInfo; } | { status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR"; }>

References

APIInterface

Re-exports APIInterface

APIOptions

Re-exports APIOptions

RecipeInterface

Re-exports RecipeInterface

UserEmailInfo

Re-exports UserEmailInfo

API reference

API schema and response details