template

Documentation

Index

• type Email
• type EmailData
• type Engine
  • func NewEngine() (*Engine, error)
  • func (e *Engine) Render(templateName string, profile config.Profile, b broker.Broker) (*Email, error)

Types

type Email

type Email struct {
	Subject string
	Body    string
}

Email represents a rendered email ready to send

type EmailData

type EmailData struct {
	// User profile
	FirstName      string
	LastName       string
	FullName       string
	Email          string
	OtherEmails    string // comma-separated additional emails, empty if none
	OtherNames     string // comma-separated name variants, empty if none
	OtherAddresses string // semicolon-separated previous addresses, empty if none
	Address        string
	City           string
	State          string
	ZipCode        string
	Country        string
	Phone          string
	OtherPhones    string // comma-separated additional phone numbers, empty if none
	DateOfBirth    string

	// Broker info
	BrokerName    string
	BrokerEmail   string
	BrokerWebsite string
	BrokerOptOut  string

	// Metadata
	Date     string
	Year     int
	Month    string
	Template string
}

EmailData contains all data available to email templates

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

Engine handles email template rendering

func NewEngine

func NewEngine() (*Engine, error)

NewEngine creates a new template engine

func (*Engine) Render

func (e *Engine) Render(templateName string, profile config.Profile, b broker.Broker) (*Email, error)

Render generates an email from a template