mail

Documentation

Index

• type Api
• type DefaultHandler
  • func (mh *DefaultHandler) Init(user, password, host, port string, inbox <-chan Mail) Api
  • func (mh *DefaultHandler) Run()
• type Mail
  • func GetChangePasswordMail(baseUIPath, secret, publicAddress, username, email, redirectTo string) Mail
  • func GetEmailConfirmationMail(baseUIPath, secret, publicAddress, username, email, challenge string) Mail

Types

type Api

type Api interface {
	Init(user, password, host, port string, inbox <-chan Mail) Api
	Run()
}

Api defines what should the mail expose

type DefaultHandler

type DefaultHandler struct {
	Inbox <-chan Mail
	// contains filtered or unexported fields
}

DefaultHandler holds the default implementation of mail

func (*DefaultHandler) Init

func (mh *DefaultHandler) Init(user, password, host, port string, inbox <-chan Mail) Api

InitFromWebBuilder initializes a default email api instance

func (*DefaultHandler) Run

func (mh *DefaultHandler) Run()

Run start the goroutine that listen for emails to send

type Mail

type Mail struct {
	To      []string
	Content []byte
}

Mail holds the content necessary for a email

func GetChangePasswordMail

func GetChangePasswordMail(baseUIPath, secret, publicAddress, username, email, redirectTo string) Mail

GetChangePasswordMail render the mail for changing password

func GetEmailConfirmationMail

func GetEmailConfirmationMail(baseUIPath, secret, publicAddress, username, email, challenge string) Mail

GetEmailConfirmationMail render the mail for email confirmation