email

Documentation

Index

• Constants
• func GetSupportedPlatforms() []types.PlatformInfo
• type EmailContent
• type EmailScope
• type ErrorInfo
• type Platform
  • func (p Platform) String() string
• type Sender
  • func NewSender(platform, config, siteName string) (Sender, error)
• type Task
• type Worker
  • func NewWorker(ctx context.Context, id int64, db *gorm.DB, sender Sender) *Worker
  • func (w *Worker) GetID() int64
  • func (w *Worker) IsRunning() uint8
  • func (w *Worker) Start()
• type WorkerManager
  • func NewWorkerManager(db *gorm.DB, sender Sender) *WorkerManager
  • func (m *WorkerManager) AddWorker(id int64)
  • func (m *WorkerManager) GetWorker(id int64) *Worker
  • func (m *WorkerManager) RemoveWorker(id int64)

Constants

const (
	DefaultEmailVerifyTemplate = `` /* 3032-byte string literal not displayed */

	DefaultMaintenanceEmailTemplate = `` /* 2650-byte string literal not displayed */

	DefaultExpirationEmailTemplate = `` /* 2269-byte string literal not displayed */

	DefaultTrafficExceedEmailTemplate = `` /* 2082-byte string literal not displayed */

)

Functions

func GetSupportedPlatforms

func GetSupportedPlatforms() []types.PlatformInfo

Types

type EmailContent

type EmailContent struct {
	Subject string `json:"subject"`
	Content string `json:"content"`
}

EmailContent 邮件内容

type EmailScope

type EmailScope struct {
	Recipients []string `json:"recipients"`
	Additional []string `json:"additional"`
	Interval   int      `json:"interval"`
}

EmailScope 邮件任务范围

type ErrorInfo

type ErrorInfo struct {
	Error string `json:"error"`
	Email string `json:"email"`
	Time  int64  `json:"time"`
}

type Platform

type Platform int

const (
	SMTP Platform = iota
)

func (Platform) String

func (p Platform) String() string

type Sender

type Sender interface {
	Send(to []string, subject, body string) error
}

func NewSender

func NewSender(platform, config, siteName string) (Sender, error)

type Task

type Task struct {
	Id      int64  `json:"id"`
	Status  uint8  `json:"status"`
	Scope   string `json:"scope"`
	Content string `json:"content"`
	Errors  string `json:"errors"`
	Current uint64 `json:"current"`
}

Task 任务信息

type Worker

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

func NewWorker

func NewWorker(ctx context.Context, id int64, db *gorm.DB, sender Sender) *Worker

func (*Worker) GetID

func (w *Worker) GetID() int64

GetID 获取Worker的任务ID

func (*Worker) IsRunning

func (w *Worker) IsRunning() uint8

IsRunning 检查Worker是否正在运行

func (*Worker) Start

func (w *Worker) Start()

Start 启动Worker，开始处理任务

type WorkerManager

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

var (
	Manager *WorkerManager // 全局调度器实例

)

func NewWorkerManager

func NewWorkerManager(db *gorm.DB, sender Sender) *WorkerManager

func (*WorkerManager) AddWorker

func (m *WorkerManager) AddWorker(id int64)

AddWorker 添加一个新的 Worker 实例

func (*WorkerManager) GetWorker

func (m *WorkerManager) GetWorker(id int64) *Worker

GetWorker 获取指定任务的 Worker 实例

func (*WorkerManager) RemoveWorker

func (m *WorkerManager) RemoveWorker(id int64)

RemoveWorker 移除指定任务的 Worker 实例