notify

Documentation

Overview

Package notify providers error delivery via email

Index

• type Params
• type SendersParams
• type Service
  • func NewService(notifyParams Params, sendersParams SendersParams) *Service
  • func (s *Service) IsOnCompletion() bool
  • func (s *Service) IsOnError() bool
  • func (s *Service) MakeCompletionHTML(spec, command string) (string, error)
  • func (s *Service) MakeErrorHTML(spec, command, errorLog string) (string, error)
  • func (s *Service) Send(ctx context.Context, subj, text string) error

Types

type Params

type Params struct {
	EnabledError       bool
	EnabledCompletion  bool
	ErrorTemplate      string
	CompletionTemplate string
}

Params which are used in all notify destinations

type SendersParams

type SendersParams struct {
	notify.SMTPParams
	FromEmail string
	ToEmails  []string

	SlackToken    string
	SlackChannels []string

	TelegramToken        string
	TelegramDestinations []string

	WebhookURLs []string
}

SendersParams contains params specific for notify destinations like email, slack, telegram or webhook

type Service

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

Service warps email client and template management

func NewService

func NewService(notifyParams Params, sendersParams SendersParams) *Service

NewService makes notification service with optional template files

func (*Service) IsOnCompletion

func (s *Service) IsOnCompletion() bool

IsOnCompletion status enabling on-passed notification

func (*Service) IsOnError

func (s *Service) IsOnError() bool

IsOnError status enabling on-error notification

func (*Service) MakeCompletionHTML

func (s *Service) MakeCompletionHTML(spec, command string) (string, error)

MakeCompletionHTML creates error html body from completionTemplate

func (*Service) MakeErrorHTML

func (s *Service) MakeErrorHTML(spec, command, errorLog string) (string, error)

MakeErrorHTML creates error html body from errorTemplate

func (*Service) Send

func (s *Service) Send(ctx context.Context, subj, text string) error

Send notification to all set up notification destinations