MailView 技术文档

1. 安装指南

首先，确保您正在使用 Rails 4.1 或更高版本，因为 MailView 是 Rails 4.1+ 的一部分。

在您的 Gemfile 中添加以下依赖项：

gem 'mail_view', :git => 'https://github.com/basecamp/mail_view.git'
# 或者
gem "mail_view", "~> 2.0.4"

然后运行 bundle install 来安装这个 gem。

2. 项目的使用说明

MailView 允许您在浏览器中预览纯文本和 HTML 邮件模板，而不需要每次更改后重新发送邮件。对于包含数据库数据的邮件，您需要编写一些场景来加载带有模拟数据的消息。

创建一个 MailPreview 类，通常放在 app/mailers/mail_preview.rb 或 lib/mail_preview.rb 中：

class MailPreview < MailView
  def invitation
    account = Account.first
    inviter, invitee = account.users[0, 2]
    Notifier.invitation(inviter, invitee)
  end

  def welcome
    user = User.create!
    mail = Notifier.welcome(user)
    user.destroy
    mail
  end

  def forgot_password
    user = Struct.new(:email, :name).new('[e-mail]', 'Jill Smith')
    UserMailer.forgot_password(user)
  end
end

确保这些方法返回一个 Mail 或 TMail 对象。

3. 项目API使用文档

MailView 使用 ActionMailer 来创建邮件对象。你可以使用 Notifier.create_action_name(args) 来返回一个兼容的 TMail 对象。在 ActionMailer 3.x 中，Notifier.action_name(args) 会返回一个 Mail 对象。

4. 项目安装方式

除了使用 Gemfile 安装外，以下是项目安装的详细步骤：

• 确认您的 Rails 环境为开发环境。
• 在 Gemfile 中添加上述 gem 依赖。
• 执行 bundle install。
• 根据您的 Rails 版本，配置路由以使用 MailView：

对于 Rails 2.x：

# config/environments/development.rb
config.middleware.use MailView::Mapper, [MailPreview]

对于 Rails 3.x：

# config/routes.rb
if Rails.env.development?
  mount MailPreview => 'mail_view'
end

完成后，启动 Rails 服务器并访问 http://localhost:3000/mail_view 来查看邮件预览。