mail

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

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