client

Documentation

Index

• Variables
• type App
  • func New(config Config) App
• type Config
  • func Flags(fs *flag.FlagSet, prefix string) Config
• type Email
  • func NewEmail() *Email
  • func (e *Email) As(sender string) *Email
  • func (e *Email) Data(payload interface{}) *Email
  • func (e *Email) From(from string) *Email
  • func (e *Email) Send(ctx context.Context, mailer App) error
  • func (e *Email) Template(template string) *Email
  • func (e *Email) To(recipients ...string) *Email
  • func (e *Email) WithSubject(subject string) *Email

Variables

var (
	// EmptyEmail for not found case
	EmptyEmail = Email{}
)

Types

type App

type App interface {
	Enabled() bool
	Send(context.Context, Email) error
}

App of package

func New

func New(config Config) App

New creates new App from Config

type Config

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

Config of package

func Flags

func Flags(fs *flag.FlagSet, prefix string) Config

Flags adds flags for configuring package

type Email

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

Email describes an email to be sent

func NewEmail

func NewEmail() *Email

NewEmail create a new email

func (*Email) As

func (e *Email) As(sender string) *Email

As set sender

func (*Email) Data

func (e *Email) Data(payload interface{}) *Email

Data set payload

func (*Email) From

func (e *Email) From(from string) *Email

From set from

func (*Email) Send

func (e *Email) Send(ctx context.Context, mailer App) error

Send email

func (*Email) Template

func (e *Email) Template(template string) *Email

Template set template

func (*Email) To

func (e *Email) To(recipients ...string) *Email

To add recipients to list

func (*Email) WithSubject

func (e *Email) WithSubject(subject string) *Email

WithSubject set subject