notifications

Documentation

Overview

Package notifications provides a module providing generic way to inform about domain changes using email notifications.

Index

• func NewModule(templateProvider RendererProvider, recipientsResolver RecipientsResolver, ...) *modular.Module
• type Email
• type Recipient
• type RecipientsResolver
• type RenderedEmail
• type Renderer
• type RendererProvider
• type Sender

Functions

func NewModule

func NewModule(
	templateProvider RendererProvider,
	recipientsResolver RecipientsResolver,
	sender Sender,
) *modular.Module

Types

type Email

type Email struct {
	To          string
	Subject     string
	HTMLContent string
}

type Recipient

type Recipient struct {
	EmailAddress string
}

type RecipientsResolver

type RecipientsResolver interface {
	Resolve(domain model.DomainAccessor, event entity.Event) []Recipient
}

type RenderedEmail

type RenderedEmail struct {
	Subject     string
	HTMLContent string
}

type Renderer

type Renderer interface {
	Render(recipient Recipient) (RenderedEmail, error)
}

type RendererProvider

type RendererProvider interface {
	Provide(domain model.DomainAccessor, e entity.Event) Renderer
}

type Sender

type Sender interface {
	Send(domain model.DomainAccessor, email Email) error
}