config

Documentation

Index

• Constants
• Variables
• type AttachmentCfg
  • func (d *AttachmentCfg) AttachFile(name string, b []byte)
• type Destination
  • func (d Destination) Addr() string
  • func (d Destination) Parse() (*ParsedDestination, error)
  • func (d Destination) ReadBodyTemplate() (*template.Template, error)
  • func (d Destination) ReadSubjectTemplate() (*template.Template, error)
• type ParsedDestination
• type Root
  • func ReadBytes(data []byte) (cfg Root, err error)
• type Source
• type TemplateArgs

Constants

const DefaultEmailBody = `` /* 204-byte string literal not displayed */

const DefaultEmailSubject = `Smart Core Notifications Monthly Report {{.Now.Format "Jan 02, 2006"}}`

Variables

var (
	DefaultSendTime = jsontypes.MustParseSchedule("0 0 * * 1")
)

Types

type AttachmentCfg

type AttachmentCfg struct {
	AttachmentName string
	Attachment     []byte
}

func (*AttachmentCfg) AttachFile

func (d *AttachmentCfg) AttachFile(name string, b []byte)

type Destination

type Destination struct {
	Host     string `json:"host,omitempty"`
	Port     int    `json:"port,omitempty"`
	Username string `json:"username,omitempty"` // defaults to From.Address
	jsontypes.Password

	From string   `json:"from,omitempty"` // RFC 5322 address, the address part used for auth against Host
	To   []string `json:"to,omitempty"`   // RFC 5322 address

	SendTime *jsontypes.Schedule `json:"sendTime,omitempty"` // defaults to midnight on Monday mornings: "0 0 * * 1"

	SubjectTemplate jsontypes.String `json:"subjectTemplate,omitempty"`
	BodyTemplate    jsontypes.String `json:"bodyTemplate,omitempty"`

	Parsed *ParsedDestination `json:"-"`
}

func (Destination) Addr

func (d Destination) Addr() string

Addr returns the combination of Host and Port, taking defaults into account. Suitable for smtp.Dial.

func (Destination) Parse

func (d Destination) Parse() (*ParsedDestination, error)

func (Destination) ReadBodyTemplate

func (d Destination) ReadBodyTemplate() (*template.Template, error)

func (Destination) ReadSubjectTemplate

func (d Destination) ReadSubjectTemplate() (*template.Template, error)

type ParsedDestination

type ParsedDestination struct {
	Addr            string
	Username        string
	Password        string
	From            *mail.Address
	To              []*mail.Address
	SubjectTemplate *template.Template
	BodyTemplate    *template.Template
}

type Root

type Root struct {
	auto.Config
	// Configuration information for how to send the email.
	Destination Destination `json:"destination,omitempty"`

	AlertHubName string `json:"source,omitempty"`

	Now func() time.Time `json:"-"`

	Timeout time.Duration `json:"timeout,omitempty"`

	Subject string `json:"subject,omitempty"`

	TemplateArgs TemplateArgs `json:"templateArgs,omitempty"`
}

func ReadBytes

func ReadBytes(data []byte) (cfg Root, err error)

type Source

type Source struct {
	Name      string `json:"name,omitempty"`
	Title     string `json:"title,omitempty"`
	Floor     string `json:"floor,omitempty"`
	Zone      string `json:"zone,omitempty"`
	Subsystem string `json:"subsystem,omitempty"`
}

type TemplateArgs

type TemplateArgs struct {
	EmailTitle string `json:"emailTitle,omitempty"`
}