stalwart

package
v3.3.13 Latest Latest
Warning

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

Go to latest
Published: Nov 18, 2026 License: BSD-3-Clause Imports: 36 Imported by: 0

Documentation

Overview

Package stalwart 把 Stalwart 邮件服务器接成面板子应用:安装脚本只放二进制与 systemd 单元, 初始化与日常管理全部通过它的 JMAP 管理接口完成

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Account

type Account struct {
	ID          string    `json:"id"`
	Name        string    `json:"name"`
	Email       string    `json:"email"`
	Description string    `json:"description"`
	Quota       uint64    `json:"quota"`
	Used        uint64    `json:"used"`
	Aliases     []string  `json:"aliases"`
	CreatedAt   time.Time `json:"created_at"`
}

type AccountCreate

type AccountCreate struct {
	Name        string   `form:"name" json:"name" validate:"required && regex:\"^[A-Za-z0-9][A-Za-z0-9._+-]{0,63}$\""`
	DomainID    string   `form:"domain_id" json:"domain_id" validate:"required"`
	Password    string   `form:"password" json:"password" validate:"required && password"`
	Description string   `form:"description" json:"description"`
	Quota       uint64   `form:"quota" json:"quota"`
	Aliases     []string `form:"aliases" json:"aliases"`
}

type AccountID

type AccountID struct {
	ID string `form:"id" json:"id" validate:"required"`
}

type AccountList

type AccountList struct {
	Page     uint   `form:"page" json:"page" query:"page"`
	Limit    uint   `form:"limit" json:"limit" query:"limit"`
	DomainID string `form:"domain_id" json:"domain_id" query:"domain_id"`
	Keyword  string `form:"keyword" json:"keyword" query:"keyword"`
}

type AccountPassword

type AccountPassword struct {
	ID       string `form:"id" json:"id" validate:"required"`
	Password string `form:"password" json:"password" validate:"required && password"`
}

type AccountUpdate

type AccountUpdate struct {
	ID          string   `form:"id" json:"id" validate:"required"`
	Description string   `form:"description" json:"description"`
	Quota       uint64   `form:"quota" json:"quota"`
	Aliases     []string `form:"aliases" json:"aliases"`
}

type App

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

func NewApp

func NewApp(
	t *gotext.Locale,
	log *slog.Logger,
	settingRepo biz.SettingRepo,
	certRepo biz.CertRepo,
	certDNSRepo biz.CertDNSRepo,
	website *biz.WebsiteUsecase,
	cert *biz.CertUsecase,
) *App

func (*App) AccountCreate

func (s *App) AccountCreate(w http.ResponseWriter, r *http.Request)

AccountCreate 创建邮箱账户,密码明文提交由 Stalwart 自行哈希

func (*App) AccountDelete

func (s *App) AccountDelete(w http.ResponseWriter, r *http.Request)

AccountDelete 删除账户及其全部邮件

func (*App) AccountList

func (s *App) AccountList(w http.ResponseWriter, r *http.Request)

AccountList 邮箱账户列表,分页由 JMAP query 完成

func (*App) AccountPassword

func (s *App) AccountPassword(w http.ResponseWriter, r *http.Request)

AccountPassword 重置账户密码,会替换掉该账户的全部登录凭据

func (*App) AccountUpdate

func (s *App) AccountUpdate(w http.ResponseWriter, r *http.Request)

AccountUpdate 修改备注、配额与别名

func (*App) Check

func (s *App) Check(w http.ResponseWriter, r *http.Request)

Check 自检:出站 25、主机名解析、PTR、黑名单、本机监听与冲突服务

func (*App) CreateProxy

func (s *App) CreateProxy(w http.ResponseWriter, r *http.Request)

CreateProxy 一键创建(或同步)反代站点:没有就以主机名建一个 proxy 类型网站指向 Stalwart 的 HTTP 监听, 已有则补齐新增域名的子域;选了证书就部署并开启 HTTPS,邮件服务还没绑证书时顺带绑上

func (*App) DomainCatchAll

func (s *App) DomainCatchAll(w http.ResponseWriter, r *http.Request)

DomainCatchAll 设置或清空域名的兜底收件地址

func (*App) DomainCreate

func (s *App) DomainCreate(w http.ResponseWriter, r *http.Request)

DomainCreate 添加域名,DKIM 密钥由 Stalwart 自动生成

func (*App) DomainDNS

func (s *App) DomainDNS(w http.ResponseWriter, r *http.Request)

DomainDNS 返回域名需要发布的 DNS 记录及其当前解析状态

func (*App) DomainDNSPublish

func (s *App) DomainDNSPublish(w http.ResponseWriter, r *http.Request)

DomainDNSPublish 用面板已配置的 DNS 账号把选中的记录写进解析商

func (*App) DomainDelete

func (s *App) DomainDelete(w http.ResponseWriter, r *http.Request)

DomainDelete 删除域名,Stalwart 要求先清掉关联的账户与 DKIM 密钥

func (*App) DomainList

func (s *App) DomainList(w http.ResponseWriter, r *http.Request)

DomainList 域名列表

func (*App) GetAdmin

func (s *App) GetAdmin(w http.ResponseWriter, r *http.Request)

GetAdmin 返回 Stalwart 管理员凭据,供用户登录它自带的 WebUI

func (*App) GetSettings

func (s *App) GetSettings(w http.ResponseWriter, r *http.Request)

GetSettings 汇总主机名、证书绑定、可选监听器与出站中继

func (*App) GetStatus

func (s *App) GetStatus(w http.ResponseWriter, r *http.Request)

GetStatus 返回初始化状态与概览,前端据此决定显示初始化向导还是管理页

func (*App) Init

func (s *App) Init(w http.ResponseWriter, r *http.Request)

Init 代替 Stalwart 的网页向导完成首次初始化: 无配置文件启动即进入引导模式,用引导凭据调用 x:Bootstrap/set 写入配置并拿到永久管理员, 随后删除引导凭据、按面板需要调整监听器与离线资源地址

func (*App) QueueDelete

func (s *App) QueueDelete(w http.ResponseWriter, r *http.Request)

QueueDelete 从队列中删除邮件,不会给发件人退信

func (*App) QueueList

func (s *App) QueueList(w http.ResponseWriter, r *http.Request)

QueueList 待投递队列

func (*App) QueueRetry

func (s *App) QueueRetry(w http.ResponseWriter, r *http.Request)

QueueRetry 立即重投,永久失败的收件人要先改回待投递状态

func (*App) Route

func (s *App) Route(r chi.Router)

func (*App) Status

func (s *App) Status(ctx context.Context) string

func (*App) UpdateCert

func (s *App) UpdateCert(w http.ResponseWriter, r *http.Request)

UpdateCert 绑定面板证书作为默认 TLS 证书,cert_id 为 0 时解绑

func (*App) UpdateHostname

func (s *App) UpdateHostname(w http.ResponseWriter, r *http.Request)

UpdateHostname 修改对外主机名,影响 EHLO、MX 记录与自动配置

func (*App) UpdateListeners

func (s *App) UpdateListeners(w http.ResponseWriter, r *http.Request)

UpdateListeners 开关 STARTTLS 端口,监听器只在启动时生效所以要重启

func (*App) UpdateRelay

func (s *App) UpdateRelay(w http.ResponseWriter, r *http.Request)

UpdateRelay 配置出站中继:维护名为 smarthost 的 Relay 路由,并把出站策略的兜底路由指过去

type CheckItem

type CheckItem struct {
	Key    string `json:"key"`
	Status string `json:"status"` // ok / warn / fail / skip
	Title  string `json:"title"`
	Detail string `json:"detail"`
}

type DNSRecord

type DNSRecord struct {
	ID     string `json:"id"`
	Type   string `json:"type"`
	Name   string `json:"name"`
	Value  string `json:"value"`
	Group  string `json:"group"`  // required / optional
	Status string `json:"status"` // ok / missing / mismatch / unknown
	Found  string `json:"found"`
	// contains filtered or unexported fields
}

DNSRecord 是从 Stalwart 区域文件解析出的一条待发布记录及其线上状态

type DNSResult

type DNSResult struct {
	Zone    string      `json:"zone"`
	Records []DNSRecord `json:"records"`
}

type Domain

type Domain struct {
	ID        string    `json:"id"`
	Name      string    `json:"name"`
	CreatedAt time.Time `json:"created_at"`
	CatchAll  string    `json:"catch_all"`
	Aliases   []string  `json:"aliases"`
	IsDefault bool      `json:"is_default"`
}

type DomainCatchAll

type DomainCatchAll struct {
	ID      string `form:"id" json:"id" validate:"required"`
	Address string `form:"address" json:"address"`
}

type DomainCreate

type DomainCreate struct {
	Name string `` /* 151-byte string literal not displayed */
}

type DomainDNSPublish

type DomainDNSPublish struct {
	ID      string   `form:"id" json:"id" validate:"required"`
	DNSID   uint     `form:"dns_id" json:"dns_id" validate:"required"`
	Records []string `form:"records" json:"records" validate:"required"`
}

type DomainID

type DomainID struct {
	ID string `form:"id" json:"id" validate:"required"`
}

type Init

type Init struct {
	Hostname string `` /* 159-byte string literal not displayed */
	Domain   string `` /* 155-byte string literal not displayed */
}

type Listeners

type Listeners struct {
	Submission bool `json:"submission"` // 587 STARTTLS
	IMAP       bool `json:"imap"`       // 143 STARTTLS
	POP3       bool `json:"pop3"`       // 110 STARTTLS
}

type ProxyCreate

type ProxyCreate struct {
	CertID uint `form:"cert_id" json:"cert_id"`
}

type QueueID

type QueueID struct {
	ID string `form:"id" json:"id" validate:"required"`
}

type QueueList

type QueueList struct {
	Page    uint   `form:"page" json:"page" query:"page"`
	Limit   uint   `form:"limit" json:"limit" query:"limit"`
	Keyword string `form:"keyword" json:"keyword" query:"keyword"`
}

type QueueMessage

type QueueMessage struct {
	ID         string           `json:"id"`
	CreatedAt  time.Time        `json:"created_at"`
	NextRetry  *time.Time       `json:"next_retry"`
	ReturnPath string           `json:"return_path"`
	Size       uint64           `json:"size"`
	Recipients []QueueRecipient `json:"recipients"`
}

type QueueRecipient

type QueueRecipient struct {
	Address    string    `json:"address"`
	Status     string    `json:"status"`
	Error      string    `json:"error"`
	RetryCount uint      `json:"retry_count"`
	RetryDue   time.Time `json:"retry_due"`
}

type Relay

type Relay struct {
	Enabled     bool   `json:"enabled"`
	Host        string `json:"host"`
	Port        uint   `json:"port"`
	Username    string `json:"username"`
	ImplicitTLS bool   `json:"implicit_tls"`
}

type SettingCert

type SettingCert struct {
	CertID uint `form:"cert_id" json:"cert_id"`
}

type SettingHostname

type SettingHostname struct {
	Hostname string `` /* 159-byte string literal not displayed */
}

type SettingListeners

type SettingListeners struct {
	Submission bool `form:"submission" json:"submission"`
	IMAP       bool `form:"imap" json:"imap"`
	POP3       bool `form:"pop3" json:"pop3"`
}

type SettingRelay

type SettingRelay struct {
	Enabled     bool   `form:"enabled" json:"enabled"`
	Host        string `form:"host" json:"host" validate:"required_if:Enabled,true"`
	Port        uint   `form:"port" json:"port" validate:"required_if:Enabled,true && min:0 && max:65535"`
	Username    string `form:"username" json:"username"`
	Password    string `form:"password" json:"password"`
	ImplicitTLS bool   `form:"implicit_tls" json:"implicit_tls"`
}

type Settings

type Settings struct {
	Hostname  string    `json:"hostname"`
	CertID    uint      `json:"cert_id"`
	Listeners Listeners `json:"listeners"`
	Relay     Relay     `json:"relay"`
}

type Status

type Status struct {
	Installed   bool   `json:"installed"`
	Initialized bool   `json:"initialized"`
	Running     bool   `json:"running"`
	Hostname    string `json:"hostname"`
	DomainCount uint   `json:"domain_count"`
	HTTPPort    int    `json:"http_port"`
	LogPath     string `json:"log_path"`
	// 一键创建的反代网站,0 表示尚未创建;缺失的主机名说明新增域名后还没同步
	ProxyWebsiteID      uint     `json:"proxy_website_id"`
	ProxyWebsiteName    string   `json:"proxy_website_name"`
	ProxyDomains        []string `json:"proxy_domains"`
	ProxyMissingDomains []string `json:"proxy_missing_domains"`
}

Jump to

Keyboard shortcuts

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