email

package

v0.0.0-...-bd48299 Latest Latest Go to latest Published: Nov 18, 2019 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Email struct{}

Email is the struct to use to implement all of the Emailer interfaces

func New() *Email

New makes a new Email struct which implements all of the "Emailer" methods

func (e *Email) SendResetPWEmail(resetPWInfo *ResetPWInfo) (bool, error)

SendResetPWEmail sends an email to a user allowing them to reset their password

type Emailer interface {
	PasswordEmailer
}

Emailer combines all of the various aspecs of our email layer into one

type PasswordEmailer interface {
	SendResetPWEmail(resetPWInfo *ResetPWInfo) (bool, error)
}

PasswordEmailer describes all of the methods used for sending emails related to a user's password

type ResetPWInfo struct {
	UserEmail string `json:"userEmail"`
	ResetURL  string `json:"resetUrl"`
}

ResetPWInfo is a convenience data structure for holding all relevant information for resetting a user's password