MailCatcher 技术文档

1. 安装指南

1.1 安装 Ruby

在安装 MailCatcher 之前，请确保你已经安装了 Ruby。你可以通过以下命令检查 Ruby 是否已安装：

ruby -v

如果没有安装 Ruby，请参考 Ruby 官方文档 进行安装。

1.2 安装 MailCatcher

使用以下命令安装 MailCatcher：

gem install mailcatcher

1.3 安装依赖工具

在某些系统上，你可能需要安装一些构建工具。例如，在 Debian 或 Ubuntu 上，你可以运行：

apt install build-essential

在 macOS 上，你可以运行：

xcode-select --install

如果你在安装 thin 时遇到问题，可以尝试以下命令：

gem install thin -v 1.5.1 -- --with-cflags="-Wno-error=implicit-function-declaration"

2. 项目的使用说明

2.1 启动 MailCatcher

安装完成后，你可以通过以下命令启动 MailCatcher：

mailcatcher

启动后，MailCatcher 会运行一个简单的 SMTP 服务器，并将捕获的邮件通过 Web 界面展示。你可以通过访问 http://127.0.0.1:1080 来查看捕获的邮件。

2.2 配置应用程序

将你的应用程序的 SMTP 服务器设置为 smtp://127.0.0.1:1025，这样所有发送的邮件都会被 MailCatcher 捕获。

2.3 查看邮件

在浏览器中访问 http://127.0.0.1:1080，你可以看到所有被捕获的邮件。邮件会显示 HTML、纯文本和源代码版本（如果适用）。

3. 项目API使用文档

MailCatcher 提供了一个简单的 RESTful API，允许你通过 URL 访问捕获的邮件。

3.1 获取所有邮件

GET /messages

返回所有捕获的邮件的 JSON 列表。

3.2 获取单个邮件的元数据

GET /messages/:id.json

返回指定邮件的元数据。

3.3 获取邮件的 HTML 版本

GET /messages/:id.html

返回指定邮件的 HTML 版本。

3.4 获取邮件的纯文本版本

GET /messages/:id.plain

返回指定邮件的纯文本版本。

3.5 获取邮件的附件

GET /messages/:id/parts/:cid

返回指定邮件的附件。

3.6 获取邮件的源代码

GET /messages/:id.source

返回指定邮件的源代码。

4. 项目安装方式

4.1 通过 RubyGems 安装

gem install mailcatcher

4.2 通过 Docker 安装

你可以使用 Docker 镜像来运行 MailCatcher：

docker run -p 1080:1080 -p 1025:1025 sj26/mailcatcher

启动后，你可以通过 http://127.0.0.1:1080 访问 MailCatcher 的 Web 界面。

4.3 通过 RVM 安装

如果你使用 RVM，可以通过以下命令在独立的 gemset 中安装 MailCatcher：

rvm default@mailcatcher --create do gem install mailcatcher
ln -s "$(rvm default@mailcatcher do rvm wrapper show mailcatcher)" "$rvm_bin_path/"

5. 其他配置

5.1 Rails 配置

在 Rails 项目中，你可以将以下配置添加到 environments/development.rb 文件中：

config.action_mailer.delivery_method = :smtp
config.action_mailer.smtp_settings = { :address => '127.0.0.1', :port => 1025 }
config.action_mailer.raise_delivery_errors = false

5.2 PHP 配置

在 PHP 项目中，你可以通过修改 php.ini 文件来配置 MailCatcher：

sendmail_path = /usr/bin/env catchmail -f [e-mail]

5.3 Django 配置

在 Django 项目中，你可以将以下配置添加到 settings.py 文件中：

if DEBUG:
    EMAIL_HOST = '127.0.0.1'
    EMAIL_HOST_USER = ''
    EMAIL_HOST_PASSWORD = ''
    EMAIL_PORT = 1025
    EMAIL_USE_TLS = False

通过以上配置，你可以轻松地在不同的开发环境中使用 MailCatcher 来捕获和查看邮件。