email

package
v0.1.13 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 17, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const DefaultProviderName = "default"
View Source
const KeyEmail runtime.Key = "email"

Variables

View Source
var (
	ErrNotConfigured       = errors.New("email: not configured")
	ErrDefaultRequired     = errors.New("email: default provider is required")
	ErrProviderNotFound    = errors.New("email: provider not found")
	ErrMessageRequired     = pkgemail.ErrMessageRequired
	ErrDriverRequired      = pkgemail.ErrDriverRequired
	ErrUnknownDriver       = pkgemail.ErrUnknownDriver
	ErrNoProviderAvailable = errors.New("email: no provider available")
)

Functions

func Bind

func Bind(app *runtime.App, manager *Manager) error

func Close

func Close() error

func LoadTemplates added in v0.1.4

func LoadTemplates(fsys fs.FS, templates map[string]Template) (map[string]Template, error)

func RegisterDriver

func RegisterDriver(driver string, factory pkgemail.DriverFactory)

func SetDefault

func SetDefault(manager *Manager)

Types

type AttemptResult

type AttemptResult = pkgemail.AttemptResult

type Config

type Config struct {
	Default   string                             `mapstructure:"default" yaml:"default"`
	Fallback  []string                           `mapstructure:"fallback" yaml:"fallback"`
	Providers map[string]pkgemail.ProviderConfig `mapstructure:"providers" yaml:"providers"`
	Templates map[string]pkgemail.Template       `mapstructure:"templates" yaml:"templates"`
}

type DirectMessage added in v0.1.4

type DirectMessage = pkgemail.DirectMessage

type Manager

type Manager struct {
	// contains filtered or unexported fields
}

func From

func From(app *runtime.App) *Manager

func ManagerDefault

func ManagerDefault() (*Manager, error)

func NewManager

func NewManager(cfg Config, middleware ...Middleware) (*Manager, error)

func (*Manager) Close

func (m *Manager) Close() error

func (*Manager) Config

func (m *Manager) Config(name string) (pkgemail.ProviderConfig, error)

func (*Manager) DefaultName

func (m *Manager) DefaultName() string

func (*Manager) Send

func (m *Manager) Send(ctx context.Context, msg Message) (*SendResult, error)

func (*Manager) SendVia

func (m *Manager) SendVia(ctx context.Context, msg Message, providers ...string) (*SendResult, error)

func (*Manager) TemplateRenderer added in v0.1.4

func (m *Manager) TemplateRenderer() pkgemail.TemplateRenderer

func (*Manager) Use

func (m *Manager) Use(name string) (pkgemail.Provider, error)

func (*Manager) UseMiddleware

func (m *Manager) UseMiddleware(middleware ...Middleware)

type Message

type Message = pkgemail.Message

type Middleware

type Middleware = pkgemail.Middleware

type NoProviderAvailableError

type NoProviderAvailableError struct {
	Attempts []AttemptResult
}

func (*NoProviderAvailableError) Error

func (e *NoProviderAvailableError) Error() string

func (*NoProviderAvailableError) Is

func (e *NoProviderAvailableError) Is(target error) bool

func (*NoProviderAvailableError) LastError

func (e *NoProviderAvailableError) LastError() error

type Payload added in v0.1.4

type Payload = pkgemail.Payload

type Provider

type Provider = pkgemail.Provider

func Use

func Use(name string) (Provider, error)

type ProviderConfig

type ProviderConfig = pkgemail.ProviderConfig

type ProviderResult

type ProviderResult = pkgemail.ProviderResult

type Request

type Request = pkgemail.Request

type SendResult

type SendResult = pkgemail.SendResult

func Send

func Send(ctx context.Context, msg Message) (*SendResult, error)

func SendVia

func SendVia(ctx context.Context, msg Message, providers ...string) (*SendResult, error)

type Sender

type Sender = pkgemail.Sender

type SenderFunc

type SenderFunc = pkgemail.SenderFunc

type Template added in v0.1.4

type Template = pkgemail.Template

type TemplateMap added in v0.1.4

type TemplateMap = pkgemail.TemplateMap

type TemplateMessage added in v0.1.4

type TemplateMessage = pkgemail.TemplateMessage

type TemplateRenderer added in v0.1.4

type TemplateRenderer = pkgemail.TemplateRenderer

type TemplateRendererFunc added in v0.1.4

type TemplateRendererFunc = pkgemail.TemplateRendererFunc

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL