notification

Documentation

Index

• type FileNotifier
  • func NewFileNotifier(configuration schema.FileSystemNotifierConfiguration) *FileNotifier
  • func (n *FileNotifier) Send(recipient, subject, body, _ string) error
  • func (n *FileNotifier) StartupCheck() (bool, error)
• type Notifier
• type SMTPNotifier
  • func NewSMTPNotifier(configuration *schema.SMTPNotifierConfiguration, certPool *x509.CertPool) *SMTPNotifier
  • func (n *SMTPNotifier) Send(recipient, title, body, htmlBody string) error
  • func (n *SMTPNotifier) StartupCheck() (bool, error)

Types

type FileNotifier

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

FileNotifier a notifier to send emails to SMTP servers.

func NewFileNotifier

func NewFileNotifier(configuration schema.FileSystemNotifierConfiguration) *FileNotifier

NewFileNotifier create an FileNotifier writing the notification into a file.

func (*FileNotifier) Send

func (n *FileNotifier) Send(recipient, subject, body, _ string) error

Send send a identity verification link to a user.

func (*FileNotifier) StartupCheck

func (n *FileNotifier) StartupCheck() (bool, error)

StartupCheck checks the file provider can write to the specified file.

type Notifier

type Notifier interface {
	Send(recipient, subject, body, htmlBody string) error
	StartupCheck() (bool, error)
}

Notifier interface for sending the identity verification link.

type SMTPNotifier

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

SMTPNotifier a notifier to send emails to SMTP servers.

func NewSMTPNotifier

func NewSMTPNotifier(configuration *schema.SMTPNotifierConfiguration, certPool *x509.CertPool) *SMTPNotifier

NewSMTPNotifier creates a SMTPNotifier using the notifier configuration.

func (*SMTPNotifier) Send

func (n *SMTPNotifier) Send(recipient, title, body, htmlBody string) error

Send is used to send an email to a recipient.

func (*SMTPNotifier) StartupCheck

func (n *SMTPNotifier) StartupCheck() (bool, error)

StartupCheck checks the server is functioning correctly and the configuration is correct.