confirm

Documentation

Overview

Package confirm implements confirmation of user registration via e-mail

Index

• Constants
• type Confirm
  • func (c *Confirm) Initialize(ab *authboss.Authboss) (err error)
  • func (c *Confirm) Routes() authboss.RouteTable
  • func (c *Confirm) Storage() authboss.StorageOptions
• type ConfirmStorer

Constants

const (
	StoreConfirmToken = "confirm_token"
	StoreConfirmed    = "confirmed"

	FormValueConfirm = "cnf"
)

Storer and FormValue constants

Types

type Confirm

type Confirm struct {
	*authboss.Authboss
	// contains filtered or unexported fields
}

Confirm module

func (*Confirm) Initialize

func (c *Confirm) Initialize(ab *authboss.Authboss) (err error)

Initialize the module

func (*Confirm) Routes

func (c *Confirm) Routes() authboss.RouteTable

Routes for the module

func (*Confirm) Storage

func (c *Confirm) Storage() authboss.StorageOptions

Storage requirements

type ConfirmStorer

type ConfirmStorer interface {
	authboss.Storer
	// ConfirmUser looks up a user by a confirm token. See confirm module for
	// attribute names. If the token is not found in the data store,
	// simply return nil, ErrUserNotFound.
	ConfirmUser(confirmToken string) (interface{}, error)
}

ConfirmStorer must be implemented in order to satisfy the confirm module's storage requirements.