package email import ( "crypto/tls" "fmt" "math" "strings" "github.com/TwiN/gatus/v5/alerting/alert" "github.com/TwiN/gatus/v5/client" "github.com/TwiN/gatus/v5/config/endpoint" gomail "gopkg.in/mail.v2" ) // AlertProvider is the configuration necessary for sending an alert using SMTP 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"` } // Override is a case under which the default integration is overridden type Override struct { Group string `yaml:"group"` To string `yaml:"to"` } // IsValid returns whether the provider's configuration is valid func (provider *AlertProvider) IsValid() bool { registeredGroups := make(map[string]bool) if provider.Overrides != nil { for _, override := range provider.Overrides { if isAlreadyRegistered := registeredGroups[override.Group]; isAlreadyRegistered || override.Group == "" || len(override.To) == 0 { return false } registeredGroups[override.Group] = true } } return len(provider.From) > 0 && len(provider.Host) > 0 && len(provider.To) > 0 && provider.Port > 0 && provider.Port < math.MaxUint16 } // Send an alert using the provider func (provider *AlertProvider) Send(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) error { var username string if len(provider.Username) > 0 { username = provider.Username } else { username = provider.From } subject, body := provider.buildMessageSubjectAndBody(ep, alert, result, resolved) m := gomail.NewMessage() m.SetHeader("From", provider.From) m.SetHeader("To", strings.Split(provider.getToForGroup(ep.Group), ",")...) m.SetHeader("Subject", subject) m.SetBody("text/plain", body) var d *gomail.Dialer if len(provider.Password) == 0 { // Get the domain in the From address localName := "localhost" fromParts := strings.Split(provider.From, `@`) if len(fromParts) == 2 { localName = fromParts[1] } // Create a dialer with no authentication d = &gomail.Dialer{Host: provider.Host, Port: provider.Port, LocalName: localName} } else { // Create an authenticated dialer d = gomail.NewDialer(provider.Host, provider.Port, username, provider.Password) } if provider.ClientConfig != nil && provider.ClientConfig.Insecure { d.TLSConfig = &tls.Config{InsecureSkipVerify: true} } return d.DialAndSend(m) } // buildMessageSubjectAndBody builds the message subject and body func (provider *AlertProvider) buildMessageSubjectAndBody(ep *endpoint.Endpoint, alert *alert.Alert, result *endpoint.Result, resolved bool) (string, string) { var subject, message string if resolved { subject = fmt.Sprintf("[%s] Alert resolved", ep.DisplayName()) message = fmt.Sprintf("An alert for %s has been resolved after passing successfully %d time(s) in a row", ep.DisplayName(), alert.SuccessThreshold) } else { subject = fmt.Sprintf("[%s] Alert triggered", ep.DisplayName()) message = fmt.Sprintf("An alert for %s has been triggered due to having failed %d time(s) in a row", ep.DisplayName(), alert.FailureThreshold) } var formattedConditionResults string if len(result.ConditionResults) > 0 { formattedConditionResults = "\n\nCondition results:\n" for _, conditionResult := range result.ConditionResults { var prefix string if conditionResult.Success { prefix = "✅" } else { prefix = "❌" } formattedConditionResults += fmt.Sprintf("%s %s\n", prefix, conditionResult.Condition) } } var description string if alertDescription := alert.GetDescription(); len(alertDescription) > 0 { description = "\n\nAlert description: " + alertDescription } return subject, message + description + formattedConditionResults } // getToForGroup returns the appropriate email integration to for a given group func (provider *AlertProvider) getToForGroup(group string) string { if provider.Overrides != nil { for _, override := range provider.Overrides { if group == override.Group { return override.To } } } return provider.To } // GetDefaultAlert returns the provider's default alert configuration func (provider *AlertProvider) GetDefaultAlert() *alert.Alert { return provider.DefaultAlert }