email

Documentation

Index

• Variables
• func Compose(ctx context.Context, out io.Writer, tpl *template.Template, ...) error
• func Register(ctx context.Context, vm *goja.Runtime)
• func Send(ctx context.Context) func(e *Email) (int, error)
• func SendActivation(ctx context.Context, code uint64) error
• func SendInviteToExistingUser(ctx context.Context, by *models.User, site *models.Site, to string) error
• func SendInviteToNewUser(ctx context.Context, by *models.User, site *models.Site, i *models.Invitation) error
• func SendPasswordReset(ctx context.Context, usr *models.User, link string) error
• func Set(ctx context.Context, m Mailer) context.Context
• type Address
• type Email
• type MailHog
  • func (m *MailHog) SendMail(from string, to []string, msg io.Reader) error
• type Mailer
  • func FromConfig(o *config.Options) (Mailer, error)
  • func Get(ctx context.Context) Mailer
• type SMTP
  • func (s *SMTP) Close() error
  • func (s *SMTP) From() *mail.Address
  • func (s *SMTP) SendMail(from string, to []string, msg io.Reader) error

Variables

var (
	ErrMailerNotConfigured = errors.New("Mailer not configured")
	ErrEmailCreationFailed = errors.New("Email creation failed")
	ErrEmailSendingFailed  = errors.New("Email sending failed")
)

Functions

func Compose

func Compose(ctx context.Context,
	out io.Writer, tpl *template.Template,
	from, to *mail.Address, subject string, f ...func(*templates.Context)) error

func Register

func Register(ctx context.Context, vm *goja.Runtime)

func Send

func Send(ctx context.Context) func(e *Email) (int, error)

func SendActivation

func SendActivation(ctx context.Context, code uint64) error

func SendInviteToExistingUser

func SendInviteToExistingUser(ctx context.Context, by *models.User, site *models.Site, to string) error

func SendInviteToNewUser

func SendInviteToNewUser(ctx context.Context, by *models.User, site *models.Site, i *models.Invitation) error

func SendPasswordReset

func SendPasswordReset(ctx context.Context, usr *models.User, link string) error

func Set

func Set(ctx context.Context, m Mailer) context.Context

Types

type Address

type Address struct {
	Name    string `json:"name"`
	Address string `json:"address"`
}

type Email

type Email struct {
	To          *Address `json:"to"`
	Subject     string   `json:"subject"`
	ContentType string   `json:"contentType"`
	Message     string   `json:"msg"`
}

type MailHog

type MailHog struct {
	*SMTP
}

func (*MailHog) SendMail

func (m *MailHog) SendMail(from string, to []string, msg io.Reader) error

type Mailer

type Mailer interface {
	SendMail(from string, to []string, msg io.Reader) error
	From() *mail.Address
	io.Closer
}

func FromConfig

func FromConfig(o *config.Options) (Mailer, error)

func Get

func Get(ctx context.Context) Mailer

type SMTP

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

func (*SMTP) Close

func (s *SMTP) Close() error

func (*SMTP) From

func (s *SMTP) From() *mail.Address

func (*SMTP) SendMail

func (s *SMTP) SendMail(from string, to []string, msg io.Reader) error