Module recipe/emailverification

Type declaration

• getEmailVerificationTokenFromURL:function

  • getEmailVerificationTokenFromURL(input: { userContext: any }): string

  • Reads and returns the email verification token from the current URL

    Parameters

    • input: { userContext: any }

      • userContext: any

    Returns string

    The "token" query parameter from the current location

• getTenantIdFromURL:function

  • getTenantIdFromURL(input: { userContext: any }): undefined | string

  • Reads and returns the tenant id from the current URL

    Parameters

    • input: { userContext: any }

      • userContext: any

    Returns undefined | string

    The "tenantId" query parameter from the current location

• isEmailVerified:function

  • isEmailVerified(input: { options?: RecipeFunctionOptions; userContext: any }): Promise<{ fetchResponse: Response; isVerified: boolean; status: "OK" }>

  • Check if an email has been verified

    throws

    STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"

    Parameters

    • input: { options?: RecipeFunctionOptions; userContext: any }

      • Optional options?: RecipeFunctionOptions

      • userContext: any

    Returns Promise<{ fetchResponse: Response; isVerified: boolean; status: "OK" }>

    {status: "OK", isVerified: boolean}

• sendVerificationEmail:function

  • sendVerificationEmail(input: { options?: RecipeFunctionOptions; userContext: any }): Promise<{ fetchResponse: Response; status: "EMAIL_ALREADY_VERIFIED_ERROR" | "OK" }>

  • Send an email to the user for verification.

    throws

    STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"

    Parameters

    • input: { options?: RecipeFunctionOptions; userContext: any }

      • Optional options?: RecipeFunctionOptions

      • userContext: any

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

    {status: "OK"} if successfull

• verifyEmail:function

  • verifyEmail(input: { options?: RecipeFunctionOptions; userContext: any }): Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" }>

  • Verify an email

    throws

    STGeneralError if the API exposed by the backend SDKs returns status: "GENERAL_ERROR"

    Parameters

    • input: { options?: RecipeFunctionOptions; userContext: any }

      • Optional options?: RecipeFunctionOptions

      • userContext: any

    Returns Promise<{ fetchResponse: Response; status: "OK" | "EMAIL_VERIFICATION_INVALID_TOKEN_ERROR" }>

    {status: "OK"} if successfull