email

Documentation

Index

• Variables
• func CanSendTo(address string) bool
• func SetBlacklist(s string)
• func SetWhitelist(s string)
• type Context
• type Message
  • func RenderMessage(ctx Context, templateName string, params Params) *Message
• type Params
  • func (p Params) Merge(p2 Params) Params
• type Recipient
  • func NewRecipient(name, address string, params Params) Recipient
  • func (r Recipient) String() string
• type Sender

Variables

var NoReply = env.Config.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 SetBlacklist

func SetBlacklist(s string)

SetBlacklist can be used to change email blacklist during runtime

func SetWhitelist

func SetWhitelist(s string)

SetWhitelist can be used to change email whitelist during runtime

Types

type Context

type Context interface {
	Tenant() *models.Tenant
	BaseURL() string
	LogoURL() string
}

Context holds everything emailers need to know about execution context

type Message

type Message struct {
	Subject string
	Body    string
}

Message represents what is sent by email

func RenderMessage

func RenderMessage(ctx Context, templateName string, params Params) *Message

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

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

func (Recipient) String

func (r Recipient) String() string

Strings returns the RFC format to send emails via SMTP

type Sender

type Sender interface {
	Send(ctx Context, templateName string, params Params, from string, to Recipient) error
	BatchSend(ctx Context, templateName string, params Params, from string, to []Recipient) error
}

Sender is used to send emails