mailservice

Documentation

Index

• type Config
• type Message
• type Sender
• type Service
  • func New(log *zap.Logger, sender Sender, templatePath string) (*Service, error)
  • func (service *Service) Close() error
  • func (service *Service) Send(ctx context.Context, msg *post.Message) (err error)
  • func (service *Service) SendRendered(ctx context.Context, to []post.Address, msg Message) (err error)
  • func (service *Service) SendRenderedAsync(ctx context.Context, to []post.Address, msg Message)

Types

type Config

type Config struct {
	SMTPServerAddress string `help:"smtp server address" default:"" testDefault:"smtp.mail.test:587"`
	TemplatePath      string `help:"path to email templates source" default:""`
	From              string `help:"sender email address" default:"" testDefault:"Labs <storj@mail.test>"`
	AuthType          string `help:"smtp authentication type" releaseDefault:"login" devDefault:"simulate"`
	Login             string `help:"plain/login auth user login" default:""`
	Password          string `help:"plain/login auth user password" default:""`
	RefreshToken      string `help:"refresh token used to retrieve new access token" default:""`
	ClientID          string `help:"oauth2 app's client id" default:""`
	ClientSecret      string `help:"oauth2 app's client secret" default:""`
	TokenURI          string `help:"uri which is used when retrieving new access token" default:""`
}

Config defines values needed by mailservice service.

type Message

type Message interface {
	Template() string
	Subject() string
}

Message defines mailservice template-backed message for SendRendered method.

type Sender

type Sender interface {
	SendEmail(ctx context.Context, msg *post.Message) error
	FromAddress() post.Address
}

Sender sends emails.

architecture: Service

type Service

type Service struct {
	Sender Sender
	// contains filtered or unexported fields
}

Service sends template-backed email messages through SMTP.

architecture: Service

func New

func New(log *zap.Logger, sender Sender, templatePath string) (*Service, error)

New creates new service.

func (*Service) Close

func (service *Service) Close() error

Close closes and waits for any pending actions.

func (*Service) Send

func (service *Service) Send(ctx context.Context, msg *post.Message) (err error)

Send is generalized method for sending custom email message.

func (*Service) SendRendered

func (service *Service) SendRendered(ctx context.Context, to []post.Address, msg Message) (err error)

SendRendered renders content from htmltemplate and texttemplate templates then sends it.

func (*Service) SendRenderedAsync

func (service *Service) SendRenderedAsync(ctx context.Context, to []post.Address, msg Message)

SendRenderedAsync renders content from htmltemplate and texttemplate templates then sends it asynchronously.