email

Documentation

Overview

Package email provides email notification support.

Index

• Constants
• func MergeOptions(ctx context.Context, src Options, dst *Options, isUpdate bool) error
• type Options
  • func (o *Options) ApplyDefaultsAndValidate(ctx context.Context) error

Constants

const ProviderType = "email"

ProviderType defines the type of the email notification provider.

Functions

func MergeOptions

func MergeOptions(ctx context.Context, src Options, dst *Options, isUpdate bool) error

MergeOptions updates the destination options with the source options.

Types

type Options

type Options struct {
	SMTPServer   string `json:"smtpServer"`
	SMTPPort     int    `json:"smtpPort"`
	SMTPIdentity string `json:"smtpIdentity"` // usually empty, most servers use username/password
	SMTPUsername string `json:"smtpUsername"`
	SMTPPassword string `json:"smtpPassword"`

	From string `json:"from"`
	To   string `json:"to"`
	CC   string `json:"cc"`

	Format string `json:"format"` // format of the message, must be "html" or "md"
}

Options defines email notification provider options.

func (*Options) ApplyDefaultsAndValidate

func (o *Options) ApplyDefaultsAndValidate(ctx context.Context) error

ApplyDefaultsAndValidate applies default values and validates the configuration.