email

README

admin/email

This package contains logic and templates for sending transactional admin emails.

How templating works

We use MJML to generate the email layout HTML. The MJML templates are found in the templates directory.

To inject content into the email layout HTML, we use Go's built-in html/template library.

We currently have just one template:

• call_to_action.mjml shows a title, body and button

Adding/updating an MJML template

1. Add or edit the .mjml file in templates (we recommend using the MJML online IDE)
2. Run ./admin/email/templates/generate.sh
3. Add a util function in email.go for loading and populating the template

Documentation

Index

• type CallToAction
• type Client
  • func New(sender Sender, frontendURL, externalURL string) *Client
  • func (c *Client) SendCallToAction(opts *CallToAction) error
  • func (c *Client) SendOrganizationAddition(opts *OrganizationAddition) error
  • func (c *Client) SendOrganizationInvite(opts *OrganizationInvite) error
  • func (c *Client) SendProjectAddition(opts *ProjectAddition) error
  • func (c *Client) SendProjectInvite(opts *ProjectInvite) error
• type OrganizationAddition
• type OrganizationInvite
• type ProjectAddition
• type ProjectInvite
• type SMTPOptions
• type Sender
  • func NewConsoleSender(logger *zap.Logger, fromEmail, fromName string) (Sender, error)
  • func NewSMTPSender(opts *SMTPOptions) (Sender, error)

Types

type CallToAction

type CallToAction struct {
	ToEmail    string
	ToName     string
	Subject    string
	Title      string
	Body       template.HTML
	ButtonText string
	ButtonLink string
}

type Client

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

func New

func New(sender Sender, frontendURL, externalURL string) *Client

func (*Client) SendCallToAction

func (c *Client) SendCallToAction(opts *CallToAction) error

func (*Client) SendOrganizationAddition

func (c *Client) SendOrganizationAddition(opts *OrganizationAddition) error

func (*Client) SendOrganizationInvite

func (c *Client) SendOrganizationInvite(opts *OrganizationInvite) error

func (*Client) SendProjectAddition

func (c *Client) SendProjectAddition(opts *ProjectAddition) error

func (*Client) SendProjectInvite

func (c *Client) SendProjectInvite(opts *ProjectInvite) error

type OrganizationAddition

type OrganizationAddition struct {
	ToEmail       string
	ToName        string
	OrgName       string
	RoleName      string
	InvitedByName string
}

type OrganizationInvite

type OrganizationInvite struct {
	ToEmail       string
	ToName        string
	OrgName       string
	RoleName      string
	InvitedByName string
}

type ProjectAddition

type ProjectAddition struct {
	ToEmail       string
	ToName        string
	OrgName       string
	ProjectName   string
	RoleName      string
	InvitedByName string
}

type ProjectInvite

type ProjectInvite struct {
	ToEmail       string
	ToName        string
	OrgName       string
	ProjectName   string
	RoleName      string
	InvitedByName string
}

type SMTPOptions

type SMTPOptions struct {
	SMTPHost     string
	SMTPPort     int
	SMTPUsername string
	SMTPPassword string
	FromEmail    string
	FromName     string
	BCC          string
}

type Sender

type Sender interface {
	Send(toEmail, toName, subject, body string) error
}

func NewConsoleSender

func NewConsoleSender(logger *zap.Logger, fromEmail, fromName string) (Sender, error)

func NewSMTPSender

func NewSMTPSender(opts *SMTPOptions) (Sender, error)