Module recipe/emailverification

generateEmailVerifyTokenPOST: undefined | ((input: { options: APIOptions; userContext: any }) => Promise<{ status: "EMAIL_ALREADY_VERIFIED_ERROR" | "OK" } | GeneralErrorResponse>)

isEmailVerifiedGET: undefined | ((input: { options: APIOptions; userContext: any }) => Promise<{ isVerified: boolean; status: "OK" } | GeneralErrorResponse>)

verifyEmailPOST: undefined | ((input: { options: APIOptions; token: string; userContext: any }) => Promise<{ status: "OK"; user: User } | { status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" } | GeneralErrorResponse>)

config: TypeNormalisedInput

emailDelivery: default<TypeEmailVerificationEmailDeliveryInput>

isInServerlessEnv: boolean

recipeId: string

recipeImplementation: RecipeInterface

req: BaseRequest

res: BaseResponse

createEmailVerificationToken:function

• createEmailVerificationToken(input: { email: string; userContext: any; userId: string }): Promise<{ status: "OK"; token: string } | { status: "EMAIL_ALREADY_VERIFIED_ERROR" }>

• Parameters

  • input: { email: string; userContext: any; userId: string }

    • email: string

    • userContext: any

    • userId: string

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

isEmailVerified:function

• isEmailVerified(input: { email: string; userContext: any; userId: string }): Promise<boolean>

• Parameters

  • input: { email: string; userContext: any; userId: string }

    • email: string

    • userContext: any

    • userId: string

  Returns Promise<boolean>

revokeEmailVerificationTokens:function

• revokeEmailVerificationTokens(input: { email: string; userContext: any; userId: string }): Promise<{ status: "OK" }>

• Parameters

  • input: { email: string; userContext: any; userId: string }

    • email: string

    • userContext: any

    • userId: string

  Returns Promise<{ status: "OK" }>

unverifyEmail:function

• unverifyEmail(input: { email: string; userContext: any; userId: string }): Promise<{ status: "OK" }>

• Parameters

  • input: { email: string; userContext: any; userId: string }

    • email: string

    • userContext: any

    • userId: string

  Returns Promise<{ status: "OK" }>

verifyEmailUsingToken:function

• verifyEmailUsingToken(input: { token: string; userContext: any }): Promise<{ status: "OK"; user: User } | { status: "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" }>

• Parameters

  • input: { token: string; userContext: any }

    • token: string

    • userContext: any

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

email: string

id: string