model

Documentation

Index

• Variables
• func InitAMQP(uri string) (*amqp.Connection, *amqp.Channel, amqp.Queue, error)
• func LoggedCloser(closer io.Closer)
• func WrapRetryable(err error) error
• type Mail
• type MailRequest
  • func NewMailRequest() *MailRequest
  • func (mr *MailRequest) As(sender string) *MailRequest
  • func (mr *MailRequest) Check() error
  • func (mr *MailRequest) ConvertToMail(content io.Reader) Mail
  • func (mr *MailRequest) Data(payload interface{}) *MailRequest
  • func (mr *MailRequest) From(fromEmail string) *MailRequest
  • func (mr *MailRequest) Template(Tpl string) *MailRequest
  • func (mr *MailRequest) To(recipients ...string) *MailRequest
  • func (mr *MailRequest) WithSubject(subject string) *MailRequest
• type Sender

Variables

var (
	// EmptyMailRequest for not found case
	EmptyMailRequest = MailRequest{}
)

var (
	// ErrRetryable occurs when an error can be retried later
	ErrRetryable = errors.New("error is retryable")
)

Functions

func InitAMQP

func InitAMQP(uri string) (*amqp.Connection, *amqp.Channel, amqp.Queue, error)

InitAMQP inits AMQP connection, channel and queue

func LoggedCloser

func LoggedCloser(closer io.Closer)

LoggedCloser closes a ressources with handling error

func WrapRetryable

func WrapRetryable(err error) error

WrapRetryable wraps given error into retryable

Types

type Mail

type Mail struct {
	From    string
	Sender  string
	Subject string
	Content io.Reader
	To      []string
}

Mail describe envelope of an email

type MailRequest

type MailRequest struct {
	Payload    interface{}
	Tpl        string
	FromEmail  string
	Sender     string
	Subject    string
	Recipients []string
}

MailRequest describes an email to be sent

func NewMailRequest

func NewMailRequest() *MailRequest

NewMailRequest create a new email

func (*MailRequest) As

func (mr *MailRequest) As(sender string) *MailRequest

As set sender

func (*MailRequest) Check

func (mr *MailRequest) Check() error

Check checks if current instance is valid

func (*MailRequest) ConvertToMail

func (mr *MailRequest) ConvertToMail(content io.Reader) Mail

ConvertToMail convert mail request to Mail with given content

func (*MailRequest) Data

func (mr *MailRequest) Data(payload interface{}) *MailRequest

Data set payload

func (*MailRequest) From

func (mr *MailRequest) From(fromEmail string) *MailRequest

From set from

func (*MailRequest) Template

func (mr *MailRequest) Template(Tpl string) *MailRequest

Template set template

func (*MailRequest) To

func (mr *MailRequest) To(recipients ...string) *MailRequest

To add recipients to list

func (*MailRequest) WithSubject

func (mr *MailRequest) WithSubject(subject string) *MailRequest

WithSubject set subject

type Sender

type Sender interface {
	Send(ctx context.Context, mail Mail) error
}

Sender send given email