email

Documentation

Overview

Package email provides an interface to send messages over email.

Index

• func RegisterNotification(name string, builder *NotificationBuilder)
• func RegisterTemplate(tmpl *Template)
• func RegisteredNotifications() []string
• func RegisteredTemplates() []string
• type Config
• type FSTemplate
• type MapNotificationRegistry
  • func NewNotificationRegistry() MapNotificationRegistry
  • func (reg MapNotificationRegistry) GetNotification(_ context.Context, name string) *NotificationBuilder
  • func (reg MapNotificationRegistry) RegisterNotification(name string, builder *NotificationBuilder)
  • func (reg MapNotificationRegistry) RegisteredNotifications() []string
• type MapTemplateRegistry
  • func NewTemplateRegistry() MapTemplateRegistry
  • func (reg MapTemplateRegistry) GetTemplate(_ context.Context, name string) *Template
  • func (reg MapTemplateRegistry) RegisterTemplate(tmpl *Template)
  • func (reg MapTemplateRegistry) RegisteredTemplates() []string
• type Message
• type NetworkConfig
• type NotificationBuilder
  • func GetNotification(ctx context.Context, name string) *NotificationBuilder
• type NotificationRegistry
• type NotificationTemplateData
  • func NewNotificationTemplateData(data TemplateData, notification *ttnpb.Notification) NotificationTemplateData
• type NotificationTemplateDataBuilder
• type Sender
• type Template
  • func GetTemplate(ctx context.Context, name string) *Template
  • func NewTemplateFS(fsys fs.FS, name string, opts FSTemplate) (*Template, error)
  • func (m Template) Execute(data TemplateData) (*Message, error)
• type TemplateData
  • func NewTemplateData(networkConfig *NetworkConfig, receiver *ttnpb.User) TemplateData
• type TemplateDataBuilder
• type TemplateRegistry

Functions

func RegisterNotification

func RegisterNotification(name string, builder *NotificationBuilder)

RegisterNotification registers an email notification on the default registry.

func RegisterTemplate

func RegisterTemplate(tmpl *Template)

RegisterTemplate registers a template on the default registry.

func RegisteredNotifications

func RegisteredNotifications() []string

RegisteredNotifications returns the names of the registered email notifications in the default registry.

func RegisteredTemplates

func RegisteredTemplates() []string

RegisteredTemplates returns the names of the registered templates in the default registry.

Types

type Config

type Config struct {
	SenderName    string        `name:"sender-name" description:"The name of the sender"`
	SenderAddress string        `name:"sender-address" description:"The address of the sender"`
	Provider      string        `name:"provider" description:"Email provider to use"`
	Network       NetworkConfig `name:"network" description:"The network of the sender"`
}

Config is the configuration for sending emails.

type FSTemplate

type FSTemplate struct {
	SubjectTemplate      string
	HTMLTemplateBaseFile string
	HTMLTemplateFile     string
	TextTemplateBaseFile string
	TextTemplateFile     string
	IncludePatterns      []string
}

FSTemplate defines the template files to parse from the file system.

type MapNotificationRegistry

type MapNotificationRegistry map[string]*NotificationBuilder

MapNotificationRegistry is an email notification registry implementation.

func NewNotificationRegistry

func NewNotificationRegistry() MapNotificationRegistry

NewNotificationRegistry returns a new empty email notification registry.

func (MapNotificationRegistry) GetNotification

func (reg MapNotificationRegistry) GetNotification(_ context.Context, name string) *NotificationBuilder

GetNotification returns a registered email notification from the registry.

func (MapNotificationRegistry) RegisterNotification

func (reg MapNotificationRegistry) RegisterNotification(name string, builder *NotificationBuilder)

RegisterNotification registers an email notification.

func (MapNotificationRegistry) RegisteredNotifications

func (reg MapNotificationRegistry) RegisteredNotifications() []string

RegisteredNotifications returns a sorted list of the names of all registered email notifications.

type MapTemplateRegistry

type MapTemplateRegistry map[string]*Template

MapTemplateRegistry is a template registry implementation.

func NewTemplateRegistry

func NewTemplateRegistry() MapTemplateRegistry

NewTemplateRegistry returns a new empty template registry.

func (MapTemplateRegistry) GetTemplate

func (reg MapTemplateRegistry) GetTemplate(_ context.Context, name string) *Template

GetTemplate returns a registered template from the registry.

func (MapTemplateRegistry) RegisterTemplate

func (reg MapTemplateRegistry) RegisterTemplate(tmpl *Template)

RegisterTemplate registers a template.

func (MapTemplateRegistry) RegisteredTemplates

func (reg MapTemplateRegistry) RegisteredTemplates() []string

RegisteredTemplates returns a sorted list of the names of all registered templates.

type Message

type Message struct {
	TemplateName string

	RecipientName    string
	RecipientAddress string

	Subject  string
	HTMLBody string
	TextBody string
}

Message for sending over email.

type NetworkConfig

type NetworkConfig struct {
	Name              string `name:"name" description:"The name of the network"`
	IdentityServerURL string `name:"identity-server-url" description:"The URL of the Identity Server"`
	ConsoleURL        string `name:"console-url" description:"The URL of the Console"`
	AssetsBaseURL     string `name:"assets-base-url" description:"The base URL to the email assets"`
	BrandingBaseURL   string `name:"branding-base-url" description:"The base URL to the email branding assets"`
}

NetworkConfig is the configuration of the network that sends the emails. This configuration is used by email templates.

type NotificationBuilder

type NotificationBuilder struct {
	EmailTemplateName string
	DataBuilder       NotificationTemplateDataBuilder
}

NotificationBuilder is used to build notifications.

func GetNotification

func GetNotification(ctx context.Context, name string) *NotificationBuilder

GetNotification returns a registered email notification from the registry in the context (if available), otherwise falling back to the default registry.

type NotificationRegistry

type NotificationRegistry interface {
	RegisteredNotifications() []string
	GetNotification(ctx context.Context, name string) *NotificationBuilder
}

NotificationRegistry keeps track of email notifications.

type NotificationTemplateData

type NotificationTemplateData interface {
	TemplateData
	Notification() *ttnpb.Notification
	ConsoleURL() string
	Receivers() string
}

NotificationTemplateData extends TemplateData for notifications.

func NewNotificationTemplateData

func NewNotificationTemplateData(data TemplateData, notification *ttnpb.Notification) NotificationTemplateData

NewNotificationTemplateData returns new notification template data.

type NotificationTemplateDataBuilder

type NotificationTemplateDataBuilder func(context.Context, NotificationTemplateData) (NotificationTemplateData, error)

NotificationTemplateDataBuilder is used to extend NotificationTemplateData.

type Sender

type Sender interface {
	Send(message *Message) error
}

Sender is the interface for sending messages over email.

type Template

type Template struct {
	Name            string
	SubjectTemplate *template.Template
	HTMLTemplate    *template.Template
	TextTemplate    *template.Template
}

Template is the template for an email message.

func GetTemplate

func GetTemplate(ctx context.Context, name string) *Template

GetTemplate returns a registered template from the registry in the context (if available), otherwise falling back to the default registry.

func NewTemplateFS

func NewTemplateFS(fsys fs.FS, name string, opts FSTemplate) (*Template, error)

NewTemplateFS parses a new email template by reading files on fsys.

func (Template) Execute

func (m Template) Execute(data TemplateData) (*Message, error)

Execute the message template, rendering it into a Message.

type TemplateData

type TemplateData interface {
	Network() *NetworkConfig
	ConsoleURL() string
	Receiver() *ttnpb.User
	ReceiverName() string
}

TemplateData is the minimal interface Execute needs to render an email template.

func NewTemplateData

func NewTemplateData(networkConfig *NetworkConfig, receiver *ttnpb.User) TemplateData

NewTemplateData returns new template data.

type TemplateDataBuilder

type TemplateDataBuilder func(context.Context, TemplateData) (TemplateData, error)

TemplateDataBuilder is used to extend TemplateData.

type TemplateRegistry

type TemplateRegistry interface {
	RegisteredTemplates() []string
	GetTemplate(ctx context.Context, name string) *Template
}

TemplateRegistry keeps track of email templates.