rest

Documentation

Overview

Package rest exposes a simple API for posting emails

Index

• Variables
• func ValidateFormat(email string) error
• type MailerHandler
  • func (mh *MailerHandler) Filter() func(string) string
  • func (mh *MailerHandler) ResolveUser(ctx context.Context, user *mailer.User) (*mailer.User, error)
  • func (mh *MailerHandler) Send(req *restful.Request, rsp *restful.Response)
  • func (mh *MailerHandler) SwaggerTags() []string

Variables

var (
	ErrBadFormat = errors.New("invalid format")
)

Functions

func ValidateFormat

func ValidateFormat(email string) error

Types

type MailerHandler

type MailerHandler struct{}

MailerHandler provides implementation of method interfaces to communicate with the configured MTA for this instance

func (*MailerHandler) Filter

func (mh *MailerHandler) Filter() func(string) string

Filter returns a function to filter the swagger path

func (*MailerHandler) ResolveUser

func (mh *MailerHandler) ResolveUser(ctx context.Context, user *mailer.User) (*mailer.User, error)

func (*MailerHandler) Send

func (mh *MailerHandler) Send(req *restful.Request, rsp *restful.Response)

Send puts a mail in the queue to be send

func (*MailerHandler) SwaggerTags

func (mh *MailerHandler) SwaggerTags() []string

SwaggerTags list the names of the service tags declared in the swagger json implemented by this service