sms

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 KeySMS runtime.Key = "sms"

Variables

View Source
var (
	ErrNotConfigured       = errors.New("sms: not configured")
	ErrDefaultRequired     = errors.New("sms: default provider is required")
	ErrProviderNotFound    = errors.New("sms: provider not found")
	ErrDriverRequired      = pkgsms.ErrDriverRequired
	ErrUnknownDriver       = pkgsms.ErrUnknownDriver
	ErrNoProviderAvailable = errors.New("sms: no provider available")
	ErrProviderFailed      = errors.New("sms: provider send failed")
	ErrRateLimited         = errors.New("sms: rate limited")
)

Functions

func Bind

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

func Close

func Close() error

func PhoneKey

func PhoneKey(req Request) string

func RegisterDriver

func RegisterDriver(driver string, factory pkgsms.DriverFactory)

func SetDefault

func SetDefault(manager *Manager)

Types

type AttemptResult

type AttemptResult = pkgsms.AttemptResult

type Config

type Config struct {
	Default   string                           `mapstructure:"default" yaml:"default"`
	Providers map[string]pkgsms.ProviderConfig `mapstructure:"providers" yaml:"providers"`
}

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) (pkgsms.ProviderConfig, error)

func (*Manager) DefaultName

func (m *Manager) DefaultName() string

func (*Manager) Send

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

func (*Manager) SendVia

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

func (*Manager) Use

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

func (*Manager) UseMiddleware

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

type Message

type Message = pkgsms.Message

type Middleware

type Middleware = pkgsms.Middleware

func RateLimitMiddleware

func RateLimitMiddleware(limiter RateLimiter, rule RateLimitRule) 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 Param

type Param = pkgsms.Param

type Payload

type Payload = pkgsms.Payload

func ResolvePayload added in v0.1.4

func ResolvePayload(provider string, payloads map[string]Payload) (Payload, error)

type Provider

type Provider = pkgsms.Provider

func Use

func Use(name string) (Provider, error)

type ProviderConfig

type ProviderConfig = pkgsms.ProviderConfig

type ProviderMessage

type ProviderMessage = pkgsms.ProviderMessage

type ProviderRequest

type ProviderRequest = pkgsms.ProviderRequest

type ProviderResult

type ProviderResult = pkgsms.ProviderResult

type RateLimitRule

type RateLimitRule struct {
	Key    func(Request) string
	Limit  int64
	Window time.Duration
}

type RateLimiter

type RateLimiter interface {
	Allow(ctx context.Context, key string, limit int64, window time.Duration) (bool, error)
}

type Request

type Request = pkgsms.Request

type SendResult

type SendResult = pkgsms.SendResult

func Send

func Send(ctx context.Context, to []string, msg Message) (*SendResult, error)

func SendVia

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

type Sender

type Sender = pkgsms.Sender

type SenderFunc

type SenderFunc = pkgsms.SenderFunc

type TemplateMessage

type TemplateMessage = pkgsms.TemplateMessage

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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