templates

Documentation

Index

• Constants
• type Config
• type EmailEnvelopeBodyValues
• type EmailEnvelopeValues
• type EmailIdentityVerificationValues
• type EmailPasswordResetValues
• type Format
• type HTMLPlainTextTemplate
  • func (f HTMLPlainTextTemplate) Get(format Format) (t *template.Template)
• type NotificationTemplates
• type Provider
  • func New(config Config) (provider *Provider, err error)
  • func (p Provider) ExecuteEmailEnvelope(wr io.Writer, data EmailEnvelopeValues) (err error)
  • func (p Provider) ExecuteEmailIdentityVerificationTemplate(wr io.Writer, data EmailIdentityVerificationValues, format Format) (err error)
  • func (p Provider) ExecuteEmailPasswordResetTemplate(wr io.Writer, data EmailPasswordResetValues, format Format) (err error)
• type Templates

Constants

const (
	TemplateNameEmailEnvelope                 = "Envelope.tmpl"
	TemplateNameEmailIdentityVerificationHTML = "IdentityVerification.html"
	TemplateNameEmailIdentityVerificationTXT  = "IdentityVerification.txt"
	TemplateNameEmailPasswordResetHTML        = "PasswordReset.html"
	TemplateNameEmailPasswordResetTXT         = "PasswordReset.txt"
)

Template File Names.

const (
	TemplateCategoryNotifications = "notification"
)

Template Category Names.

Types

type Config

type Config struct {
	EmailTemplatesPath string
}

Config for the Provider.

type EmailEnvelopeBodyValues

type EmailEnvelopeBodyValues struct {
	PlainText string
	HTML      string
}

EmailEnvelopeBodyValues are the values used for the email envelopes bodies.

type EmailEnvelopeValues

type EmailEnvelopeValues struct {
	ProcessID    int
	UUID         string
	Host         string
	ServerName   string
	SenderDomain string
	Identifier   string
	From         string
	To           string
	Subject      string
	Date         time.Time
	Boundary     string
	Body         EmailEnvelopeBodyValues
}

EmailEnvelopeValues are the values used for the email envelopes.

type EmailIdentityVerificationValues

type EmailIdentityVerificationValues struct {
	UUID        string
	Title       string
	DisplayName string
	RemoteIP    string
	LinkURL     string
	LinkText    string
}

EmailIdentityVerificationValues are the values used for the identity verification templates.

type EmailPasswordResetValues

type EmailPasswordResetValues struct {
	UUID        string
	Title       string
	DisplayName string
	RemoteIP    string
}

EmailPasswordResetValues are the values used for password reset templates.

type Format

type Format int

Format of a template.

const (
	DefaultFormat Format = iota
	HTMLFormat
	PlainTextFormat
)

Formats.

type HTMLPlainTextTemplate

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

HTMLPlainTextTemplate is the template type which contains both the html and txt versions of a template.

func (HTMLPlainTextTemplate) Get

func (f HTMLPlainTextTemplate) Get(format Format) (t *template.Template)

Get returns the appropriate template given the format.

type NotificationTemplates

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

NotificationTemplates are the templates for the notification system.

type Provider

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

Provider of templates.

func New

func New(config Config) (provider *Provider, err error)

New creates a new templates' provider.

func (Provider) ExecuteEmailEnvelope

func (p Provider) ExecuteEmailEnvelope(wr io.Writer, data EmailEnvelopeValues) (err error)

ExecuteEmailEnvelope writes the envelope template to the given io.Writer.

func (Provider) ExecuteEmailIdentityVerificationTemplate

func (p Provider) ExecuteEmailIdentityVerificationTemplate(wr io.Writer, data EmailIdentityVerificationValues, format Format) (err error)

ExecuteEmailIdentityVerificationTemplate writes the identity verification template to the given io.Writer.

func (Provider) ExecuteEmailPasswordResetTemplate

func (p Provider) ExecuteEmailPasswordResetTemplate(wr io.Writer, data EmailPasswordResetValues, format Format) (err error)

ExecuteEmailPasswordResetTemplate writes the password reset template to the given io.Writer.

type Templates

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

Templates is the struct which holds all the *template.Template values.