mailer

Documentation

Overview

Package mailer provides a simple mailer for sending emails.

Index

• func RenderWelcome() (string, error)
• type Mailer
  • func (m *Mailer) Ready() bool
  • func (m *Mailer) Send(msg *Message) error
• type Message
• type MessageBuilder
  • func NewMessageBuilder() *MessageBuilder
  • func (mb *MessageBuilder) Build() *Message
  • func (mb *MessageBuilder) SetBody(body string) *MessageBuilder
  • func (mb *MessageBuilder) SetFrom(name, from string) *MessageBuilder
  • func (mb *MessageBuilder) SetSubject(subject string) *MessageBuilder
  • func (mb *MessageBuilder) SetTo(name, to string) *MessageBuilder
• type TemplateDefaults
• type TemplateProps
  • func DefaultTemplateData() TemplateProps
  • func (tp *TemplateProps) Set(key, value string)

Functions

func RenderWelcome

func RenderWelcome() (string, error)

Types

type Mailer

type Mailer struct {
	Host     string `json:"host,omitempty"`
	Port     int    `json:"port,omitempty"`
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
	From     string `json:"from,omitempty"`
}

func (*Mailer) Ready

func (m *Mailer) Ready() bool

func (*Mailer) Send

func (m *Mailer) Send(msg *Message) error

type Message

type Message struct {
	Subject string
	To      mail.Address
	From    mail.Address
	Body    string
}

type MessageBuilder

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

func NewMessageBuilder

func NewMessageBuilder() *MessageBuilder

func (*MessageBuilder) Build

func (mb *MessageBuilder) Build() *Message

func (*MessageBuilder) SetBody

func (mb *MessageBuilder) SetBody(body string) *MessageBuilder

func (*MessageBuilder) SetFrom

func (mb *MessageBuilder) SetFrom(name, from string) *MessageBuilder

func (*MessageBuilder) SetSubject

func (mb *MessageBuilder) SetSubject(subject string) *MessageBuilder

func (*MessageBuilder) SetTo

func (mb *MessageBuilder) SetTo(name, to string) *MessageBuilder

type TemplateDefaults

type TemplateDefaults struct {
	CompanyName        string
	CompanyAddress     string
	CompanyURL         string
	ActivateAccountURL string
	UnsubscribeURL     string
}

type TemplateProps

type TemplateProps struct {
	Defaults TemplateDefaults
	Data     map[string]string
}

func DefaultTemplateData

func DefaultTemplateData() TemplateProps

func (*TemplateProps) Set

func (tp *TemplateProps) Set(key, value string)