邮件安全网（mail_safe）技术文档

1. 安装指南

在您的项目中使用mail_safe之前，需要先将其安装到您的开发环境中。您可以通过以下两种方式安装mail_safe：

• 通过Gem安装： 在命令行中执行以下命令安装mail_safe。

  gem install mail_safe
  

• 通过GitHub： 如果您希望从源代码安装，可以从GitHub上的mail_safe仓库克隆或下载代码。

  git clone https://github.com/myronmarston/mail_safe.git
  

然后，确保在Rails的Gemfile文件中添加以下内容，并在相应的环境中加载该gem：

gem "mail_safe", group: [:development, :staging]

重要提示：请不要在生产环境中加载此gem，否则您的电子邮件将不会被发送给正确的收件人。在测试环境中，您也可能不需要它，因为Rails确保测试环境中不会发送任何电子邮件。

2. 使用说明

mail_safe的作用是在开发过程中防止电子邮件被发送到外部邮箱，从而为您提供一个安全网。一旦安装并配置好这个gem，您的应用程序将不会将电子邮件发送到外部地址。相反，原本应该发送到外部地址的电子邮件会被发送到您指定的地址，并在电子邮件底部附上说明，指出原始的发送对象。

配置

大多数情况下，不需要进行额外的配置。如果您安装了git并且已经注册了您的电子邮件地址（在shell中运行git config user.email进行检查），mail_safe将使用此地址。否则，可以创建一个config/initializers/mail_safe.rb文件，并按照以下示例进行配置：

if defined?(MailSafe::Config)
  MailSafe::Config.internal_address_definition = /.*@my-domain\.com/i
  MailSafe::Config.replacement_address = '[e-mail]'
end

在此配置中，internal_address_definition定义了哪些地址会被忽略（即正常发送），而所有其他电子邮件地址将被替换为replacement_address中指定的地址。这些设置也可以是procs，以便提供更灵活的配置。

当mail_safe替换电子邮件地址时，会在邮件底部附加一条通知，例如：

**************************************************
此电子邮件原本有其他收件人，
但MailSafe已阻止其发送给他们。

原始收件人是：
- to:
  - [e-mail]
  - [e-mail]
- cc:
  - [e-mail]

**************************************************

3. 项目API使用文档

mail_safe作为一个gem，提供了几个配置选项，主要用于确定哪些电子邮件地址应该被替换以及替换成什么地址。以下是一些主要的配置选项：

• MailSafe::Config.internal_address_definition: 一个正则表达式或proc，用于定义内部地址，即不会被替换的地址。
• MailSafe::Config.replacement_address: 替换后的电子邮件地址，可以是一个字符串或proc。

4. 项目安装方式

如前所述，项目可以通过Ruby的gem系统进行安装。在您的Rails项目的Gemfile文件中添加如下代码：

gem "mail_safe", group: [:development, :staging]

然后执行以下命令来安装gem：

bundle install

确保只在开发和预发布环境中加载此gem，以避免影响生产环境的邮件发送。