email

Documentation

Overview

Package email implements a Pilot notification plugin that sends events as plain-text emails via an SMTP server.

Index

• type Config
• type Notifier
  • func New(cfg Config) *Notifier
  • func (n *Notifier) Name() string
  • func (n *Notifier) Notify(_ context.Context, event plugin.NotificationEvent) error
  • func (n *Notifier) Test(ctx context.Context) error

Types

type Config

type Config struct {
	Host     string   `json:"host"`
	Port     int      `json:"port"` // default: 587
	Username string   `json:"username,omitempty"`
	Password string   `json:"password,omitempty"`
	From     string   `json:"from"`
	To       []string `json:"to"`
	TLS      bool     `json:"tls,omitempty"` // use TLS (port 465 style); false = STARTTLS
}

Config holds the user-supplied settings for an email notifier.

type Notifier

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

Notifier is an email notifier plugin instance.

func New

func New(cfg Config) *Notifier

New creates a new Notifier from the given config.

func (*Notifier) Name

func (n *Notifier) Name() string

func (*Notifier) Notify

func (n *Notifier) Notify(_ context.Context, event plugin.NotificationEvent) error

Notify sends the event as a plain-text email.

func (*Notifier) Test

func (n *Notifier) Test(ctx context.Context) error

Test sends a test email to verify SMTP connectivity.