mailer

Documentation

Index

• type DefaultMailer
  • func New(addr string, auth smtp.Auth, options ...DefaultMailerConfigurator) *DefaultMailer
  • func (m *DefaultMailer) SendMail(ctx context.Context, from string, to []string, subject string, body string) error
  • func (m *DefaultMailer) String() string
• type DefaultMailerConfigurator
  • func WithStartTLS(v bool) DefaultMailerConfigurator
  • func WithTLS(v bool) DefaultMailerConfigurator
  • func WithTLSConfig(cfg *tls.Config) DefaultMailerConfigurator
• type DummyMailer
  • func NewDummy() *DummyMailer
  • func (m *DummyMailer) SendMail(ctx context.Context, from string, to []string, subject string, body string) error
• type Mailer
• type Message

Types

type DefaultMailer

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

func New

func New(addr string, auth smtp.Auth, options ...DefaultMailerConfigurator) *DefaultMailer

func (*DefaultMailer) SendMail

func (m *DefaultMailer) SendMail(ctx context.Context, from string, to []string, subject string, body string) error

func (*DefaultMailer) String

func (m *DefaultMailer) String() string

type DefaultMailerConfigurator

type DefaultMailerConfigurator func(m *DefaultMailer)

func WithStartTLS

func WithStartTLS(v bool) DefaultMailerConfigurator

func WithTLS

func WithTLS(v bool) DefaultMailerConfigurator

func WithTLSConfig

func WithTLSConfig(cfg *tls.Config) DefaultMailerConfigurator

type DummyMailer

type DummyMailer struct {
	Messages []Message
}

DummyMailer is an implementation of Mailer that only adds the passed message into the internal Messages field.

func NewDummy

func NewDummy() *DummyMailer

NewDummy creates a new DummyMailer.

func (*DummyMailer) SendMail

func (m *DummyMailer) SendMail(ctx context.Context, from string, to []string, subject string, body string) error

type Mailer

type Mailer interface {
	SendMail(ctx context.Context, from string, to []string, subject string, body string) error
}

Mailer is something that can send out an email.

type Message

type Message struct {
	From    string
	To      []string
	Subject string
	Body    string
}

Message as it is stored by the DummyMailer when using its SendMail method.