email

Documentation

Index

• type AlertProvider
  • func (provider *AlertProvider) GetDefaultAlert() *alert.Alert
  • func (provider *AlertProvider) IsValid() bool
  • func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, ...) error
• type Override

Types

type AlertProvider

type AlertProvider struct {
	From     string `yaml:"from"`
	Username string `yaml:"username"`
	Password string `yaml:"password"`
	Host     string `yaml:"host"`
	Port     int    `yaml:"port"`
	To       string `yaml:"to"`

	// ClientConfig is the configuration of the client used to communicate with the provider's target
	ClientConfig *client.Config `yaml:"client,omitempty"`

	// DefaultAlert is the default alert configuration to use for endpoints with an alert of the appropriate type
	DefaultAlert *alert.Alert `yaml:"default-alert,omitempty"`

	// Overrides is a list of Override that may be prioritized over the default configuration
	Overrides []Override `yaml:"overrides,omitempty"`
}

AlertProvider is the configuration necessary for sending an alert using SMTP

func (*AlertProvider) GetDefaultAlert

func (provider *AlertProvider) GetDefaultAlert() *alert.Alert

GetDefaultAlert returns the provider's default alert configuration

func (*AlertProvider) IsValid

func (provider *AlertProvider) IsValid() bool

IsValid returns whether the provider's configuration is valid

func (*AlertProvider) Send

func (provider *AlertProvider) Send(endpoint *core.Endpoint, alert *alert.Alert, result *core.Result, resolved bool) error

Send an alert using the provider

type Override

type Override struct {
	Group string `yaml:"group"`
	To    string `yaml:"to"`
}

Override is a case under which the default integration is overridden