email

package
v0.1.21 Latest Latest
Warning

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

Go to latest
Published: Sep 28, 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")
	ErrAttachmentInvalid   = pkgemail.ErrAttachmentInvalid
	ErrAttachmentOpen      = pkgemail.ErrAttachmentOpen
)

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 Attachment added in v0.1.16

type Attachment = pkgemail.Attachment

type AttachmentOpenError added in v0.1.16

type AttachmentOpenError = pkgemail.AttachmentOpenError

type AttachmentSource added in v0.1.16

type AttachmentSource = pkgemail.AttachmentSource

type AttachmentSourceFunc added in v0.1.16

type AttachmentSourceFunc = pkgemail.AttachmentSourceFunc

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 NewDynamicManager added in v0.1.16

func NewDynamicManager(resolver ProviderResolver, renderer TemplateRenderer, middleware ...Middleware) (*Manager, error)

NewDynamicManager 创建一个由运行时 Resolver 提供账号配置的邮件管理器。 动态管理器不要求默认账号,调用方应通过 SendVia 明确传入账号路由。

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 ProviderResolver added in v0.1.16

type ProviderResolver interface {
	Resolve(ctx context.Context, name string) (ProviderConfig, error)
}

ProviderResolver 按稳定账号名解析当前可用的邮件 Provider 配置。 实现方可以从数据库或配置中心读取,但不得在错误和日志中泄露密码。

type ProviderResolverFunc added in v0.1.16

type ProviderResolverFunc func(ctx context.Context, name string) (ProviderConfig, error)

ProviderResolverFunc 将函数适配为 ProviderResolver。

func (ProviderResolverFunc) Resolve added in v0.1.16

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