mail

Documentation

Index

• Constants
• type Notifier
  • func New(config json.RawMessage) (Notifier, error)
  • func (m Notifier) Notify(results []types.Result) error
  • func (Notifier) Type() string

Constants

const Type = "mail"

Type should match the package name

Types

type Notifier

type Notifier struct {
	// From contains the e-mail address notifications are sent from
	From string `json:"from"`

	// To contains a list of e-mail address destinations
	To []string `json:"to"`

	// Subject contains customizable subject line
	Subject string `json:"subject,omitempty"`

	// SMTP contains all relevant mail server settings
	SMTP struct {
		Server   string `json:"server"`
		Port     int    `json:"port,omitempty"`
		Username string `json:"username,omitempty"`
		Password string `json:"password,omitempty"`
	} `json:"smtp"`
}

Notifier consist of all the sub components required to send E-mail notifications

func New

func New(config json.RawMessage) (Notifier, error)

New creates a new Notifier instance based on json config

func (Notifier) Notify

func (m Notifier) Notify(results []types.Result) error

Notify implements notifier interface

func (Notifier) Type

func (Notifier) Type() string

Type returns the notifier package name