email

README

runtime/pkg/email

This package contains logic and templates for sending transactional 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 ./runtime/pkg/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) *Client
  • func (c *Client) SendAlertStatus(opts *drivers.AlertStatus) error
  • func (c *Client) SendCallToAction(opts *CallToAction) error
  • func (c *Client) SendInformational(opts *Informational) error
  • func (c *Client) SendOrganizationAddition(opts *OrganizationAddition) error
  • func (c *Client) SendOrganizationInvite(opts *OrganizationInvite) error
  • func (c *Client) SendProjectAccessGranted(opts *ProjectAccessGranted) error
  • func (c *Client) SendProjectAccessRejected(opts *ProjectAccessRejected) error
  • func (c *Client) SendProjectAccessRequest(opts *ProjectAccessRequest) error
  • func (c *Client) SendProjectAddition(opts *ProjectAddition) error
  • func (c *Client) SendProjectInvite(opts *ProjectInvite) error
  • func (c *Client) SendScheduledReport(opts *ScheduledReport) error
• type Informational
• type OrganizationAddition
• type OrganizationInvite
• type ProjectAccessGranted
• type ProjectAccessRejected
• type ProjectAccessRequest
• type ProjectAddition
• type ProjectInvite
• type SMTPOptions
• type ScheduledReport
• type Sender
  • func NewConsoleSender(logger *zap.Logger, fromEmail, fromName string) (Sender, error)
  • func NewNoopSender() Sender
  • func NewSMTPSender(opts *SMTPOptions) (Sender, error)
  • func NewTestSender() Sender
• type TestSender
  • func (s *TestSender) Send(toEmail, toName, subject, body string) 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 {
	Sender Sender
	// contains filtered or unexported fields
}

func New

func New(sender Sender) *Client

func (*Client) SendAlertStatus

func (c *Client) SendAlertStatus(opts *drivers.AlertStatus) error

func (*Client) SendCallToAction

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

func (*Client) SendInformational

func (c *Client) SendInformational(opts *Informational) error

func (*Client) SendOrganizationAddition

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

func (*Client) SendOrganizationInvite

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

func (*Client) SendProjectAccessGranted

func (c *Client) SendProjectAccessGranted(opts *ProjectAccessGranted) error

func (*Client) SendProjectAccessRejected

func (c *Client) SendProjectAccessRejected(opts *ProjectAccessRejected) error

func (*Client) SendProjectAccessRequest

func (c *Client) SendProjectAccessRequest(opts *ProjectAccessRequest) error

func (*Client) SendProjectAddition

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

func (*Client) SendProjectInvite

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

func (*Client) SendScheduledReport

func (c *Client) SendScheduledReport(opts *ScheduledReport) error

type Informational

type Informational struct {
	ToEmail string
	ToName  string
	Subject string
	Title   string
	Body    template.HTML
}

type OrganizationAddition

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

type OrganizationInvite

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

type ProjectAccessGranted

type ProjectAccessGranted struct {
	ToEmail     string
	ToName      string
	FrontendURL string
	OrgName     string
	ProjectName string
}

type ProjectAccessRejected

type ProjectAccessRejected struct {
	ToEmail     string
	ToName      string
	OrgName     string
	ProjectName string
}

type ProjectAccessRequest

type ProjectAccessRequest struct {
	Title       string
	Body        template.HTML
	ToEmail     string
	ToName      string
	Email       string
	OrgName     string
	ProjectName string
	ApproveLink string
	DenyLink    string
}

type ProjectAddition

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

type ProjectInvite

type ProjectInvite struct {
	ToEmail       string
	ToName        string
	AdminURL      string
	FrontendURL   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 ScheduledReport

type ScheduledReport struct {
	ToEmail        string
	ToName         string
	Title          string
	ReportTime     time.Time
	DownloadFormat string
	OpenLink       string
	DownloadLink   string
	EditLink       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 NewNoopSender

func NewNoopSender() Sender

func NewSMTPSender

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

func NewTestSender

func NewTestSender() Sender

type TestSender

type TestSender struct {
	Emails []struct {
		ToEmail string
		ToName  string
		Subject string
		Body    string
	}
}

func (*TestSender) Send

func (s *TestSender) Send(toEmail, toName, subject, body string) error