mail

Documentation

Overview

Package mail provides a light wrapper around SMTP functionality.

Index

• Variables
• func NewModelList(m *model.Manager, key string) (*modelList, error)
• type Config
• type List
• type Recipient
  • func (r Recipient) String() string
• type Sender
  • func NewSender(conf Config, l log.Logger) *Sender
  • func (s *Sender) Send(recipient Recipient, subject, message string) error

Variables

var ErrRecipientUnsubscribed = errors.New("recipient has requested no email communication")

Functions

func NewModelList

func NewModelList(m *model.Manager, key string) (*modelList, error)

Types

type Config

type Config struct {
	SMTPAddress  string `toml:"smtp_address"`
	SMTPUsername string `toml:"smtp_username"`
	SMTPPassword string `toml:"smtp_password"`

	System Recipient `toml:"system"` // The system's address.
}

Config describes a Sender's configuration.

type List

type List interface {
	Add(Recipient) error
	Exists(Recipient) bool
}

type Recipient

type Recipient struct {
	Name  string `toml:"name"`
	Email string `toml:"email"`
}

A Recipient is an email recipient.

func (Recipient) String

func (r Recipient) String() string

type Sender

type Sender struct {
	DoNotSend List
	// contains filtered or unexported fields
}

A Sender handles sending of email.

func NewSender

func NewSender(conf Config, l log.Logger) *Sender

NewSender creates a new Sender, ready for use.

func (*Sender) Send

func (s *Sender) Send(recipient Recipient, subject, message string) error

Send sends an email with the given HTML message to the recipient.