email

Documentation

Index

• Constants
• Variables
• type Emailer
  • func NewEmailer(p Params) *Emailer
  • func (e *Emailer) SendEmail(receivers []string, subject string, body string, attachmentFilePath []string) error
  • func (e *Emailer) SendEmailWithLimit(receivers []string, subject string, body string, attachmentFilePath []string) error
  • func (e *Emailer) SendInviteUserEmail(receivers []string, params map[string]string) error
  • func (e *Emailer) SendResetPasswordEmail(receivers []string, params map[string]string) error
• type Params
• type TemplateParams

Constants

const (
	ResetPasswordURLPath = "/auth/resetpassword" //#nosec
	InviteUserURLPath    = "/auth/users/create"  //#nosec

)

Variables

var ErrRateLimitExceeded = errors.New("rate limit exceeded")

Types

type Emailer

type Emailer struct {
	Params  Params
	Dialer  *gomail.Dialer
	Limiter *rate.Limiter
}

func NewEmailer

func NewEmailer(p Params) *Emailer

func (*Emailer) SendEmail

func (e *Emailer) SendEmail(receivers []string, subject string, body string, attachmentFilePath []string) error

func (*Emailer) SendEmailWithLimit

func (e *Emailer) SendEmailWithLimit(receivers []string, subject string, body string, attachmentFilePath []string) error

func (*Emailer) SendInviteUserEmail

func (e *Emailer) SendInviteUserEmail(receivers []string, params map[string]string) error

func (*Emailer) SendResetPasswordEmail

func (e *Emailer) SendResetPasswordEmail(receivers []string, params map[string]string) error

type Params

type Params struct {
	SMTPHost           string
	SMTPPort           int
	UseSSL             bool
	Username           string
	Password           string
	LocalName          string
	Sender             string
	LimitEveryDuration time.Duration
	Burst              int
	LakefsBaseURL      string
}

type TemplateParams

type TemplateParams struct {
	URL string
}