smtp

Documentation

Index

• Constants
• func Send(payload Payload) error
• type Notifier
  • func Register() *Notifier
  • func (n Notifier) Information() models.Information
  • func (n Notifier) Init(fields map[string]any) error
  • func (n Notifier) Parameters() models.Parameters
  • func (n Notifier) Run(log utils.LogLine) error
• type Parameters
• type Payload
  • func NewPayload(log utils.LogLine) (Payload, error)

Constants

const (
	Name        string = "smtp"
	Description string = "Send an email with SMTP"
	Permissions string = ""
	Example     string = `` /* 201-byte string literal not displayed */

)

const (
	Red   string = "#e20b0b"
	Green string = "#23ba47"
	Grey  string = "#a4a8b1"
	Text  string = "text"
)

Functions

func Send

func Send(payload Payload) error

Types

type Notifier

type Notifier struct{}

func Register

func Register() *Notifier

func (Notifier) Information

func (n Notifier) Information() models.Information

func (Notifier) Init

func (n Notifier) Init(fields map[string]any) error

func (Notifier) Parameters

func (n Notifier) Parameters() models.Parameters

func (Notifier) Run

func (n Notifier) Run(log utils.LogLine) error

type Parameters

type Parameters struct {
	HostPort string `field:"host_port" validate:"required"`
	User     string `field:"user"`
	Password string `field:"password"`
	From     string `field:"from" validate:"required"`
	To       string `field:"to" validate:"required"`
	Format   string `field:"format" default:"html"`
	TLS      bool   `field:"tls" default:"false"`
}

type Payload

type Payload struct {
	From    string
	To      string
	Subject string
	Body    string
	Mime    string
	Date    string
}

Payload

func NewPayload

func NewPayload(log utils.LogLine) (Payload, error)