emailverification

Documentation

Index

• Constants
• Variables
• func AfterEach()
• func BeforeEach()
• func CreateEmailVerificationToken(userID, email string) (evmodels.CreateEmailVerificationTokenResponse, error)
• func CreateEmailVerificationTokenWithContext(userID, email string, userContext supertokens.UserContext) (evmodels.CreateEmailVerificationTokenResponse, error)
• func DefaultCreateAndSendCustomEmail(appInfo supertokens.NormalisedAppinfo) func(user evmodels.User, emailVerifyURLWithToken string, ...)
• func DefaultGetEmailVerificationURL(appInfo supertokens.NormalisedAppinfo) func(evmodels.User, supertokens.UserContext) (string, error)
• func Init(config evmodels.TypeInput) supertokens.Recipe
• func IsEmailVerified(userID, email string) (bool, error)
• func IsEmailVerifiedWithContext(userID, email string, userContext supertokens.UserContext) (bool, error)
• func MakeSMTPService(config emaildelivery.SMTPServiceConfig) *emaildelivery.EmailDeliveryInterface
• func ResetForTest()
• func RevokeEmailVerificationTokens(userID, email string) (evmodels.RevokeEmailVerificationTokensResponse, error)
• func RevokeEmailVerificationTokensWithContext(userID, email string, userContext supertokens.UserContext) (evmodels.RevokeEmailVerificationTokensResponse, error)
• func SendEmail(input emaildelivery.EmailType) error
• func SendEmailWithContext(input emaildelivery.EmailType, userContext supertokens.UserContext) error
• func UnverifyEmail(userID, email string) (evmodels.UnverifyEmailResponse, error)
• func UnverifyEmailWithContext(userID, email string, userContext supertokens.UserContext) (evmodels.UnverifyEmailResponse, error)
• func VerifyEmailUsingToken(token string) (evmodels.VerifyEmailUsingTokenResponse, error)
• func VerifyEmailUsingTokenWithContext(token string, userContext supertokens.UserContext) (evmodels.VerifyEmailUsingTokenResponse, error)
• type Recipe
  • func MakeRecipe(recipeId string, appInfo supertokens.NormalisedAppinfo, ...) (Recipe, error)

Constants

const RECIPE_ID = "emailverification"

Variables

var EmailVerificationDataForTest = struct {
	User                    evmodels.User
	EmailVerifyURLWithToken string
	UserContext             supertokens.UserContext
}{}

var EmailVerificationEmailSentForTest = false

used for testing purposes.

Functions

func AfterEach

func AfterEach()

func BeforeEach

func BeforeEach()

func CreateEmailVerificationToken

func CreateEmailVerificationToken(userID, email string) (evmodels.CreateEmailVerificationTokenResponse, error)

func CreateEmailVerificationTokenWithContext

func CreateEmailVerificationTokenWithContext(userID, email string, userContext supertokens.UserContext) (evmodels.CreateEmailVerificationTokenResponse, error)

func DefaultCreateAndSendCustomEmail

func DefaultCreateAndSendCustomEmail(appInfo supertokens.NormalisedAppinfo) func(user evmodels.User, emailVerifyURLWithToken string, userContext supertokens.UserContext)

func DefaultGetEmailVerificationURL

func DefaultGetEmailVerificationURL(appInfo supertokens.NormalisedAppinfo) func(evmodels.User, supertokens.UserContext) (string, error)

func Init

func Init(config evmodels.TypeInput) supertokens.Recipe

func IsEmailVerified

func IsEmailVerified(userID, email string) (bool, error)

func IsEmailVerifiedWithContext

func IsEmailVerifiedWithContext(userID, email string, userContext supertokens.UserContext) (bool, error)

func MakeSMTPService

func MakeSMTPService(config emaildelivery.SMTPServiceConfig) *emaildelivery.EmailDeliveryInterface

func ResetForTest

func ResetForTest()

func RevokeEmailVerificationTokens

func RevokeEmailVerificationTokens(userID, email string) (evmodels.RevokeEmailVerificationTokensResponse, error)

func RevokeEmailVerificationTokensWithContext

func RevokeEmailVerificationTokensWithContext(userID, email string, userContext supertokens.UserContext) (evmodels.RevokeEmailVerificationTokensResponse, error)

func SendEmail

func SendEmail(input emaildelivery.EmailType) error

func SendEmailWithContext

func SendEmailWithContext(input emaildelivery.EmailType, userContext supertokens.UserContext) error

func UnverifyEmail

func UnverifyEmail(userID, email string) (evmodels.UnverifyEmailResponse, error)

func UnverifyEmailWithContext

func UnverifyEmailWithContext(userID, email string, userContext supertokens.UserContext) (evmodels.UnverifyEmailResponse, error)

func VerifyEmailUsingToken

func VerifyEmailUsingToken(token string) (evmodels.VerifyEmailUsingTokenResponse, error)

func VerifyEmailUsingTokenWithContext

func VerifyEmailUsingTokenWithContext(token string, userContext supertokens.UserContext) (evmodels.VerifyEmailUsingTokenResponse, error)

Types

type Recipe

type Recipe struct {
	RecipeModule  supertokens.RecipeModule
	Config        evmodels.TypeNormalisedInput
	RecipeImpl    evmodels.RecipeInterface
	APIImpl       evmodels.APIInterface
	EmailDelivery emaildelivery.Ingredient
}

func MakeRecipe

func MakeRecipe(recipeId string, appInfo supertokens.NormalisedAppinfo, config evmodels.TypeInput, emailDeliveryIngredient *emaildelivery.Ingredient, onSuperTokensAPIError func(err error, req *http.Request, res http.ResponseWriter)) (Recipe, error)