email

Documentation

Index

• type Email
  • func NewEmail(c smtp.SmtpClient) *Email
  • func (e *Email) Build(glob string, params interface{}) error
  • func (e *Email) Send(emailAddr, subject string) error
• type Message
• type TemplateName
  • func (t TemplateName) String() string

Types

type Email

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

func NewEmail

func NewEmail(c smtp.SmtpClient) *Email

func (*Email) Build

func (e *Email) Build(glob string, params interface{}) error

TODO(subomi): glob pattern must not match more than one template

func (*Email) Send

func (e *Email) Send(emailAddr, subject string) error

type Message

type Message struct {

	// Email represents email recipient.
	Email string `json:"email,omitempty"`

	// Subject of the email
	Subject string `json:"subject,omitempty"`

	// Params to replace the template variables.
	Params interface{} `json:"params,omitempty"`

	// Glob represents which template to use in building the email
	TemplateName TemplateName `json:"template_name,omitempty"`
}

Message represents a generic email message. It can be anything from an organisation invite to a disabled endpoint email

type TemplateName

type TemplateName string

const (
	TemplateEndpointUpdate     TemplateName = "endpoint.update"
	TemplateOrganisationInvite TemplateName = "organisation.invite"
	TemplateResetPassword      TemplateName = "reset.password"
	TemplateTwitterSource      TemplateName = "twitter.source"
)

func (TemplateName) String

func (t TemplateName) String() string