email

Documentation

Index

• Variables
• func CanSendTo(address string) bool
• func SetWhitelist(s string)
• type Message
  • func RenderMessage(templateName string, params Params) *Message
• type NoopSender
  • func NewNoopSender() *NoopSender
  • func (s *NoopSender) BatchSend(tenant *models.Tenant, templateName string, params Params, from string, ...) error
  • func (s *NoopSender) Send(tenant *models.Tenant, templateName string, params Params, from string, ...) error
• type Params
  • func (p Params) Merge(p2 Params) Params
• type Recipient
  • func NewRecipient(name, address string, params Params) Recipient
• type Sender

Variables

var NoReply = env.MustGet("EMAIL_NOREPLY")

NoReply is the default 'from' address

Functions

func CanSendTo

func CanSendTo(address string) bool

CanSendTo returns true if Fider is allowed to send email to given address

func SetWhitelist

func SetWhitelist(s string)

SetWhitelist can be used to change email whitelist during rutime

Types

type Message

type Message struct {
	Subject string
	Body    string
}

Message represents what is sent by email

func RenderMessage

func RenderMessage(templateName string, params Params) *Message

RenderMessage returns the HTML of an email based on template and params

type NoopSender

type NoopSender struct {
}

NoopSender does not send emails

func NewNoopSender

func NewNoopSender() *NoopSender

NewNoopSender creates a new NoopSender

func (*NoopSender) BatchSend

func (s *NoopSender) BatchSend(tenant *models.Tenant, templateName string, params Params, from string, to []Recipient) error

BatchSend an email to multiple recipients

func (*NoopSender) Send

func (s *NoopSender) Send(tenant *models.Tenant, templateName string, params Params, from string, to Recipient) error

Send an email

type Params

type Params map[string]interface{}

Params used to replace variables on emails

func (Params) Merge

func (p Params) Merge(p2 Params) Params

Merge given params into current params

type Recipient

type Recipient struct {
	Name    string
	Address string
	Params  Params
}

Recipient contains details of who is receiving the email

func NewRecipient

func NewRecipient(name, address string, params Params) Recipient

NewRecipient creates a new Recipient

type Sender

type Sender interface {
	Send(tenant *models.Tenant, templateName string, params Params, from string, to Recipient) error
	BatchSend(tenant *models.Tenant, templateName string, params Params, from string, to []Recipient) error
}

Sender is used to send emails