email_password

package

v2.6.0 Latest Latest Go to latest Published: Feb 6, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/GoBetterAuth/go-better-auth

Links

Open Source Insights

Documentation ¶

Index ¶

func BuildUseCases(p *EmailPasswordPlugin) *usecases.UseCases
func Routes(plugin *EmailPasswordPlugin) []models.Route
type API
- func BuildAPI(plugin *EmailPasswordPlugin) *API
type EmailPasswordPlugin
- func New(config types.EmailPasswordPluginConfig) *EmailPasswordPlugin

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func BuildUseCases ¶

func BuildUseCases(p *EmailPasswordPlugin) *usecases.UseCases

func Routes ¶

func Routes(plugin *EmailPasswordPlugin) []models.Route

Routes returns all routes for the email/password plugin

Types ¶

type API ¶

type API struct {
	// contains filtered or unexported fields
}

func BuildAPI ¶

func BuildAPI(plugin *EmailPasswordPlugin) *API

func (*API) ChangePassword ¶

func (a *API) ChangePassword(ctx context.Context, tokenStr string, newPassword string) error

func (*API) RequestEmailChange ¶

func (a *API) RequestEmailChange(ctx context.Context, userID string, newEmail string, callbackURL *string) error

func (*API) RequestPasswordReset ¶

func (a *API) RequestPasswordReset(ctx context.Context, email string, callbackURL *string) error

func (*API) SendEmailVerification ¶

func (a *API) SendEmailVerification(ctx context.Context, email string, callbackURL *string) error

func (a *API) SignIn(
	ctx context.Context,
	email string,
	password string,
	callbackURL *string,
	ipAddress *string,
	userAgent *string,
) (*types.SignInResult, error)

func (a *API) SignUp(
	ctx context.Context,
	name string,
	email string,
	password string,
	image *string,
	callbackURL *string,
	ipAddress *string,
	userAgent *string,
) (*types.SignUpResult, error)

func (*API) VerifyEmail ¶

func (a *API) VerifyEmail(ctx context.Context, tokenStr string) (models.VerificationType, error)

type EmailPasswordPlugin ¶

type EmailPasswordPlugin struct {
	Api *API
	// contains filtered or unexported fields
}

func New ¶

func New(config types.EmailPasswordPluginConfig) *EmailPasswordPlugin

func (*EmailPasswordPlugin) Close ¶

func (p *EmailPasswordPlugin) Close() error

func (*EmailPasswordPlugin) Config ¶

func (p *EmailPasswordPlugin) Config() any

func (*EmailPasswordPlugin) Init ¶

func (p *EmailPasswordPlugin) Init(ctx *models.PluginContext) error

func (*EmailPasswordPlugin) Metadata ¶

func (p *EmailPasswordPlugin) Metadata() models.PluginMetadata

func (*EmailPasswordPlugin) OnConfigUpdate ¶

func (p *EmailPasswordPlugin) OnConfigUpdate(config *models.Config) error

func (*EmailPasswordPlugin) Routes ¶

func (p *EmailPasswordPlugin) Routes() []models.Route

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
constants
handlers
services
types
usecases

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL