ghcr.io/jinnrry/pmail:prev2.4.1

PMail

一台服务器，一个域名，一行代码，一分钟，即可搭建属于你自己的域名***。

一台服务器，一个域名，一行代码，一分钟，即可搭建属于你自己的域名***。

中文文档

我是中国人，英语不太好，因此对我的翻译表示歉意。

简介

PMail 是一款追求极简部署流程和极致资源消耗的个人邮件服务器。它以单文件运行，包含完整的邮件收发服务和 Web 端邮件管理功能。只需一台服务器、一个域名、一行代码、一分钟部署时间，你就能搭建属于自己的域名***。

欢迎各种 PR，无论是修复 bug、添加功能，还是优化翻译。同时，为该项目征集一个漂亮可爱的 Logo！

特性

• 单文件运行，部署简单。
• 二进制文件仅 15MB，运行时内存占用不足 10M。
• 支持 DKIM、SPF 校验，正确配置可获得 Email Test 10 分评分。
• 实现 ACME 协议，程序会自动获取并更新 Let's Encrypt 证书。

[!NOTE] 默认情况下，会为 Web 服务生成 SSL 证书，使页面可使用 HTTPS 协议。如果您有自己的网关或不需要 HTTPS，请在配置文件中将 httpsEnabled 设置为 2，这样 Web 服务将不使用 HTTPS。（注意：即使不需要 HTTPS，也请确保 SSL 证书文件路径正确，虽然 Web 服务不再使用该证书，但 SMTP 协议仍需要证书）

• 支持 POP3、SMTP 协议，可使用任何您喜欢的邮件客户端。
• 支持多域名、多用户，完整支持邮件收发。

运行方法

0、检查 IP/域名

首先前往 spamhaus 检查您的域名和服务器 IP 是否有封禁记录。

1、下载

• https://github.com/Jinnrry/PMail/releases 下载适合您的程序文件。
• 或使用 Docker：docker pull ghcr.io/jinnrry/pmail:latest

2、运行

./pmail -p 80

-p 设置引导设置界面的 HTTP 端口，默认为 80 端口，注意此参数仅影响引导设置阶段，若设置完成后需要更改端口，请修改配置文件。

[!IMPORTANT] 如果引导设置阶段使用 80 以外的端口，SSL 证书将不会自动设置。

或使用 Docker：

docker run -p 25:25 -p 80:80 -p 443:443 -p 110:110 -p 465:465 -p 587:587 -p 995:995 -p 993:993 -v $(pwd)/config:/work/config ghcr.io/jinnrry/pmail:latest

[!IMPORTANT] 如果您的服务器开启了防火墙，需要开放端口 25、80、110、443、465、587、993、995。

3、配置

在浏览器中打开 http://127.0.0.1 或使用服务器公网 IP 访问，然后按照提示进行配置。

4、邮件测试

检查您的是否完成所有安全配置。建议使用 [] 进行检查。

配置文件格式说明

{
  "logLevel": "info", // 日志输出级别
  "domain": "domain.com", // 您的域名
  "webDomain": "mail.domain.com", // Web 域名
  "dkimPrivateKeyPath": "config/dkim/dkim.priv", // DKIM 密钥路径
  "sslType": "0", // SSL 证书更新模式，0 自动，1 手动
  "SSLPrivateKeyPath": "config/ssl/private.key", // SSL 证书私钥路径
  "SSLPublicKeyPath": "config/ssl/public.crt", // SSL 证书公钥路径
  "dbDSN": "./config/pmail.db", // 数据库连接 DSN
  "dbType": "sqlite", // 数据库类型，`sqlite` 或 `mysql`
  "httpsEnabled": 0, // 是否启用 HTTPS，0: 启用 1: 启用 2: 禁用
  "httpPort": 80, // HTTP 端口，默认 80
  "httpsPort": 443, // HTTPS 端口，默认 443
  "spamFilterLevel": 0, // 垃圾邮件过滤级别：0：不过滤。1：当 SPF 和 DKIM 均失败时过滤（在没有有效收件人过滤的情况下）。2：当 SPF 检查失败时过滤（在没有有效收件人过滤的情况下）。3：当 DKIM 检查失败时过滤（在没有有效收件人过滤的情况下）
  "isInit": true // 如果为 false，将进入引导配置流程
}

邮件客户端配置

POP3 服务器地址：pop.[您的域名]
POP3 端口：110/995(SSL)

SMTP 服务器地址：smtp.[您的域名]
SMTP 端口：25/465、587(SSL)

IMAP 服务器地址：imap.[您的域名]
IMAP 端口：993(SSL)

插件

微信推送

垃圾邮件拦截

社区插件

https://github.com/ydzydzydz/pmail_***_push

插件安装

[!IMPORTANT] 插件作为独立进程在您的服务器上运行，请自行审核第三方插件的安全性。PMail 目前仅维护上述提到的三个插件。

将插件二进制文件复制到 /plugins 目录。

开发者相关

项目架构

1. 前端：vue3+element-plus
   代码位于 fe 目录。

2. 服务端：golang + MySQL/SQLite
   代码位于 server 目录。

3. 构建方法

make build

4. 单元测试

make test

API 文档

https://github.com/Jinnrry/PMail/wiki/%E5%90%8E%E7%AB%AF%E6%8E%A5%E5%8F%A3%E6%96%87%E6%A1%A3

插件开发

https://github.com/Jinnrry/PMail/wiki/%E6%8F%92%E4%BB%B6%E5%BC%80%E5%8F%91%E8%AF%B4%E6%98%8E