ServBay Mailpit 服务配置指南
ServBay 集成了 Mailpit 软件包,提供了一个便捷的本地电子邮件服务器,专为开发者测试和调试应用程序的邮件发送功能而设计。本文将详细介绍如何在 ServBay 中安装、启用并配置 Mailpit 软件包,包括 Common、SMTP、POP3 和 Relay 四个主要配置标签页。
Mailpit 软件包概览
Mailpit 是一个开源工具,提供了一个易于使用的本地 SMTP/POP3 服务器和一个直观的 Web 界面。它能够捕获您的应用程序发送的所有电子邮件,使您可以在一个集中的地方检查邮件内容、头部信息、附件等,而无需将测试邮件发送到真实的收件箱。这极大地简化了开发和调试流程,尤其是在处理用户注册、密码重置、通知等需要发送邮件的功能时。
在 ServBay 中,Mailpit 作为一项核心软件包集成,您可以轻松安装和管理它,并利用 ServBay 强大的 PKI 系统自动配置 SSL/TLS,确保安全测试环境。
安装并启用 Mailpit 软件包
在使用 Mailpit 作为本地邮件服务器之前,您需要先在 ServBay 中安装并启用 Mailpit 软件包。
- 打开 ServBay 应用。
- 在左侧导航栏中,选择
软件包
。 - 在软件包列表中,找到
通用服务
分类。 - 找到
Mailpit
软件包。 - 如果 Mailpit 未安装,点击其右侧的绿色安装按钮进行安装。
- 安装完成后,点击旁边的开关按钮以启用 Mailpit 软件包。
得益于 ServBay 强大的 PKI 系统,ServBay 将会自动为 Mailpit 的 Web 管理界面以及 SMTP、POP3 服务生成并配置所需的 SSL 证书。这意味着您可以直接启用 STARTTLS 或 SSL/TLS 加密,而无需手动申请或配置证书。
Web 邮件管理界面
Mailpit 自带了一个功能强大的 Web 界面,用于查看和管理捕获到的电子邮件。ServBay 已为您自动完成配置,一旦 Mailpit 软件包启用,您就可以直接通过浏览器访问该界面:
访问地址: https://mail.servbay.host
通过此界面,您可以方便地浏览收到的邮件列表、查看单封邮件的详细内容(包括 HTML、纯文本、源码)、搜索邮件、删除邮件等。
配置 Mailpit 软件包
ServBay 提供了图形化界面来配置 Mailpit 的各项参数。在 ServBay 的左侧导航栏中,选择 Mail
,然后点击 Mailpit Service Config
进入配置界面。您将看到 Common, SMTP, POP3, 和 Relay 四个主要配置标签页。
1. Common 标签页
Common 标签页用于配置 Mailpit 的通用设置和行为:
- Max Messages: 设置 Mailpit 服务器最多可以存储的邮件数量。当收到的邮件数量超过此限制时,最早的邮件将被自动删除。
- Max Age: 设置邮件在 Mailpit 服务器上保留的最长时间,单位为天。超过此时间限制的邮件将被自动删除。
- SpamAssassin: 启用或禁用 SpamAssassin 垃圾邮件过滤功能。如果启用,Mailpit 会尝试将收到的邮件标记为垃圾邮件。
- Webhook URL: 配置一个 Webhook URL。当 Mailpit 收到新邮件时,会向该 URL 发送一个 HTTP POST 请求,通知外部系统或服务。这对于集成自动化测试或通知系统非常有用。
- Webhook Limit: 设置 Webhook 通知发送的邮件数量上限。
2. SMTP 标签页
TIP
得益于 ServBay 强大的 PKI 系统,ServBay 已经默认生成并配置好 SSL 证书。您可以直接启用 STARTTLS 或者 SSL/TLS 加密连接,无需额外进行 SSL 证书的申请及配置。
SMTP 标签页用于配置 Mailpit 的 SMTP 服务器设置。您的应用程序将连接到此 SMTP 服务器发送测试邮件:
- SMTP Port: 设置 Mailpit SMTP 服务器监听的端口号。您的应用程序应将邮件发送目标指向
127.0.0.1
或localhost
的这个端口。默认为1025
。 - STARTTLS: 启用或禁用 STARTTLS 加密。这允许在建立连接后升级到加密通信。
- SSL/TLS: 启用或禁用 SSL/TLS 加密。这将在连接建立时立即使用加密通信。
- Username: 设置 SMTP 服务器的用户名 (可选)。如果设置,您的应用程序在发送邮件时需要提供此用户名进行身份验证。
- Password: 设置 SMTP 服务器的密码 (可选)。与 Username 配合使用进行身份验证。
- Max Recipients: 设置每封邮件允许的最大收件人数量,防止单个邮件发送给过多收件人。
- Allowed Recipients: 设置允许接收邮件的收件人地址或域名列表 (可选)。如果留空,Mailpit 将接受发往任何地址的邮件。如果设置,只有发往列表中的地址或域名的邮件会被接收。
3. POP3 标签页
TIP
得益于 ServBay 强大的 PKI 系统,ServBay 已经默认生成并配置好 SSL 证书。您可以直接启用 SSL/TLS 加密连接,无需额外进行 SSL 证书的申请及配置。
POP3 标签页用于配置 Mailpit 的 POP3 服务器设置。如果您需要测试应用程序接收邮件的功能,可以配置客户端连接到此服务器:
- Enable POP3 Server: 启用或禁用 Mailpit 的 POP3 服务器功能。
- POP3 Server Port: 设置 Mailpit POP3 服务器监听的端口号。默认为
1110
。 - Username: 设置 POP3 服务器的用户名 (可选)。如果设置,客户端在连接时需要提供此用户名进行身份验证。
- Password: 设置 POP3 服务器的密码 (可选)。与 Username 配合使用进行身份验证。
- SSL/TLS: 启用或禁用 SSL/TLS 加密连接。
4. Relay 标签页
Relay 标签页用于配置 Mailpit 的邮件转发功能。您可以将 Mailpit 配置为一个中继服务器,将捕获到的某些或所有邮件转发到真实的外部 SMTP 服务器:
- Enable SMTP Relay: 启用或禁用 SMTP 中继功能。
- Host: 设置用于中继邮件的外部 SMTP 服务器地址 (例如:
smtp.gmail.com
,smtp.sendgrid.net
)。 - Port: 设置用于中继邮件的外部 SMTP 服务器端口号。默认为
25
(标准 SMTP),465
(SMTPS), 或587
(Submission)。 - STARTTLS: 启用或禁用与中继服务器的 STARTTLS 加密连接。
- Allow Insecure: 允许连接到使用不受信任证书的中继 SMTP 服务器 (不推荐用于生产环境)。
- Auth: 选择与中继服务器进行身份验证的方式。常见的选项包括
Login
(发送用户名和密码),Plain
(类似于 Login), 和CRAM-MD5
(一种基于挑战/响应的认证机制)。 - Username: 设置用于连接中继 SMTP 服务器的用户名。
- Password: 设置用于连接中继 SMTP 服务器的密码。
- Return Path: 设置中继邮件的退信地址(
Return-Path
头部)。 - Allowed Recipients: 设置允许被中继的收件人地址或域名列表 (可选)。
- Blocked Recipients: 设置阻止被中继的收件人地址或域名列表 (可选)。
- Relay All: 如果勾选,Mailpit 将尝试中继所有捕获到的邮件(受 Allowed/Blocked Recipients 限制)。
- Relay Matching: 如果勾选,Mailpit 仅中继符合 Allowed Recipients 或 Blocked Recipients 规则的邮件。
保存配置
在对 Mailpit 配置进行任何更改后,请务必点击界面底部的 Save
按钮以保存您的设置。
点击 Reset
按钮可以将所有配置恢复到 Mailpit 的默认设置。
常见问题解答 (FAQ)
- Q: 为什么我的应用程序发送的邮件没有出现在 Mailpit 中?
- A: 请检查您的应用程序的邮件发送配置(通常是 SMTP 主机和端口),确保它们指向 ServBay 运行 Mailpit 的地址 (通常是
127.0.0.1
或localhost
) 和您在 Mailpit 配置中设置的 SMTP 端口 (默认为 1025)。同时,请确认 Mailpit 软件包已在 ServBay 中启动并运行。您可以在 ServBay 的软件包列表中查看其状态。
- A: 请检查您的应用程序的邮件发送配置(通常是 SMTP 主机和端口),确保它们指向 ServBay 运行 Mailpit 的地址 (通常是
- Q: 我需要为 Mailpit 配置 SSL 证书吗?
- A: 不需要。得益于 ServBay 强大的 PKI 系统,ServBay 会自动为 Mailpit 的 Web 界面、SMTP 和 POP3 服务的 STARTTLS/SSL/TLS 生成并配置所需的证书。您只需在相应的配置标签页中启用加密选项即可。
- Q: Mailpit 的 Web 管理界面默认用户名和密码是什么?
- A: 默认情况下,Mailpit 的 Web 界面通过
https://mail.servbay.host
访问时不需要用户名和密码。SMTP 和 POP3 服务也默认不需要认证。如果您需要在 SMTP 或 POP3 中强制要求认证,可以在相应的标签页中设置用户名和密码。
- A: 默认情况下,Mailpit 的 Web 界面通过
总结
通过 ServBay 集成的 Mailpit 软件包,您可以轻松搭建一个本地邮件测试环境。配置 Mailpit 的 SMTP、POP3 和 Relay 设置,结合其直观的 Web 界面,将极大地提高您在开发过程中处理邮件功能的效率和便捷性。
请注意,修改配置后,可能需要重启 Mailpit 软件包以使更改生效。您可以通过 ServBay 的软件包管理界面找到 Mailpit,并点击重启按钮。