mail

package

v0.0.0-...-94e6d93 Latest Latest Go to latest Published: Apr 4, 2023 License: Apache-2.0 Imports: 12 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

Repository

github.com/ngld/knossos

Documentation ¶

Index ¶

func Init(cfg *config.Config) error
func SendRegistrationMail(ctx context.Context, cfg *config.Config, params RegMailParams) error
func SendResetMail(ctx context.Context, cfg *config.Config, params ResetMailParams) error
type RegMailParams
type ResetMailParams

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Init ¶

func Init(cfg *config.Config) error

Init configuration based parts of the mail package

func SendRegistrationMail ¶

func SendRegistrationMail(ctx context.Context, cfg *config.Config, params RegMailParams) error

SendRegistrationMail sends a registration mail

func SendResetMail ¶

func SendResetMail(ctx context.Context, cfg *config.Config, params ResetMailParams) error

SendResetMail sends a password reset mail

Types ¶

type RegMailParams ¶

type RegMailParams struct {
	To       string
	Username string
	Token    string
	// This field will be set automatically
	BaseURL string
}

RegMailParams contains the values that will be passed to the mail template

type ResetMailParams ¶

type ResetMailParams struct {
	To       string
	Found    bool
	Username string
	Token    string
	// This field will be set automatically
	BaseURL string
}

ResetMailParams contains the values that will be passed to the mail template

Source Files ¶

View all Source files

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