Documentation
¶
Overview ¶
Package stalwart 把 Stalwart 邮件服务器接成面板子应用:安装脚本只放二进制与 systemd 单元, 初始化与日常管理全部通过它的 JMAP 管理接口完成
Index ¶
- type Account
- type AccountCreate
- type AccountID
- type AccountList
- type AccountPassword
- type AccountUpdate
- type App
- func (s *App) AccountCreate(w http.ResponseWriter, r *http.Request)
- func (s *App) AccountDelete(w http.ResponseWriter, r *http.Request)
- func (s *App) AccountList(w http.ResponseWriter, r *http.Request)
- func (s *App) AccountPassword(w http.ResponseWriter, r *http.Request)
- func (s *App) AccountUpdate(w http.ResponseWriter, r *http.Request)
- func (s *App) Check(w http.ResponseWriter, r *http.Request)
- func (s *App) CreateProxy(w http.ResponseWriter, r *http.Request)
- func (s *App) DomainCatchAll(w http.ResponseWriter, r *http.Request)
- func (s *App) DomainCreate(w http.ResponseWriter, r *http.Request)
- func (s *App) DomainDNS(w http.ResponseWriter, r *http.Request)
- func (s *App) DomainDNSPublish(w http.ResponseWriter, r *http.Request)
- func (s *App) DomainDelete(w http.ResponseWriter, r *http.Request)
- func (s *App) DomainList(w http.ResponseWriter, r *http.Request)
- func (s *App) GetAdmin(w http.ResponseWriter, r *http.Request)
- func (s *App) GetSettings(w http.ResponseWriter, r *http.Request)
- func (s *App) GetStatus(w http.ResponseWriter, r *http.Request)
- func (s *App) Init(w http.ResponseWriter, r *http.Request)
- func (s *App) QueueDelete(w http.ResponseWriter, r *http.Request)
- func (s *App) QueueList(w http.ResponseWriter, r *http.Request)
- func (s *App) QueueRetry(w http.ResponseWriter, r *http.Request)
- func (s *App) Route(r chi.Router)
- func (s *App) Status(ctx context.Context) string
- func (s *App) UpdateCert(w http.ResponseWriter, r *http.Request)
- func (s *App) UpdateHostname(w http.ResponseWriter, r *http.Request)
- func (s *App) UpdateListeners(w http.ResponseWriter, r *http.Request)
- func (s *App) UpdateRelay(w http.ResponseWriter, r *http.Request)
- type CheckItem
- type DNSRecord
- type DNSResult
- type Domain
- type DomainCatchAll
- type DomainCreate
- type DomainDNSPublish
- type DomainID
- type Init
- type Listeners
- type ProxyCreate
- type QueueID
- type QueueList
- type QueueMessage
- type QueueRecipient
- type Relay
- type SettingCert
- type SettingHostname
- type SettingListeners
- type SettingRelay
- type Settings
- type Status
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
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 AccountList ¶
type AccountPassword ¶
type AccountUpdate ¶
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) 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 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 DomainCatchAll ¶
type DomainCreate ¶
type DomainCreate struct {
Name string `` /* 151-byte string literal not displayed */
}
type DomainDNSPublish ¶
type ProxyCreate ¶
type ProxyCreate struct {
CertID uint `form:"cert_id" json:"cert_id"`
}
type QueueMessage ¶
type QueueRecipient ¶
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 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 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"`
}