跳至内容 跳至搜索

Action Mailer – 简化的邮件发送和测试

Action Mailer 是一个用于设计邮件服务层的框架。这些层用于整合发送密码重置、注册欢迎语、账单发票等代码,以及任何需要向个人或系统发送书面通知的用例。

Action Mailer 本质上是 Action Controller 和 Mail gem 的一个包装器。它提供了一种方法,就像 Action Controller 使用模板渲染视图一样,使用模板来创建邮件。

此外,Action Mailer 类还可以用于处理收到的邮件,例如允许博客接受来自邮件的新帖(甚至可以是从手机发送的)。

您可以在 Action Mailer 基础指南中阅读更多关于 Action Mailer 的信息。

发送邮件

该框架的工作原理是初始化您希望在邮件模板中可用的任何实例变量,然后调用 mail 来发送邮件。

这可以很简单,就像

class Notifier < ActionMailer::Base
  default from: 'system@loudthinking.com'

  def welcome(recipient)
    @recipient = recipient
    mail(to: recipient,
         subject: "[Signed up] Welcome #{recipient}")
  end
end

邮件正文是通过使用 Action View 模板(常规的 ERB)创建的,该模板包含在 mailer action 中声明的实例变量。

因此,上面方法的对应正文模板可能看起来像这样

Hello there,

Mr. <%= @recipient %>

Thank you for signing up!

如果收件人是“david@loudthinking.com”,生成的邮件将如下所示

Date: Mon, 25 Jan 2010 22:48:09 +1100
From: system@loudthinking.com
To: david@loudthinking.com
Message-ID: <4b5d84f9dd6a5_7380800b81ac29578@void.loudthinking.com.mail>
Subject: [Signed up] Welcome david@loudthinking.com
Mime-Version: 1.0
Content-Type: text/plain;
      charset="US-ASCII";
Content-Transfer-Encoding: 7bit

Hello there,

Mr. david@loudthinking.com

Thank you for signing up!

为了发送邮件,您只需调用该方法,然后对返回值调用 deliver_now

调用该方法会返回一个 Mail Message 对象

message = Notifier.welcome("david@loudthinking.com")   # => Returns a Mail::Message object
message.deliver_now                                    # => delivers the email

或者您可以将方法链接在一起,例如

Notifier.welcome("david@loudthinking.com").deliver_now # Creates the email and sends it immediately

设置默认值

可以为 Action Mailer 类中的每个方法设置默认值。要实现此功能,您只需调用从 ActionMailer::Base 免费获得的公共类方法 default。此方法接受一个 Hash 作为参数。您可以使用邮件的任何标头,例如 :from 作为键。您也可以将字符串作为键传递,例如“Content-Type”,但 Action Mailer 会为您处理这些,因此您无需担心。最后,您还可以传递一个 Proc,它将在需要时进行评估。

请注意,使用此方法设置的每个值都将在您的 mailer 方法中使用相同键时被覆盖。

示例

class AuthenticationMailer < ActionMailer::Base
  default from: "awesome@application.com", subject: Proc.new { "E-mail was generated at #{Time.now}" }
  .....
end

配置

Base 类包含完整的配置选项列表。这是一个例子

ActionMailer::Base.smtp_settings = {
  address:        'smtp.yourserver.com', # default: localhost
  port:           '25',                  # default: 25
  user_name:      'user',
  password:       'pass',
  authentication: :plain                 # :plain, :login or :cram_md5
}

下载和安装

最新版本的 Action Mailer 可以使用 RubyGems 安装

$ gem install actionmailer

源代码可以作为 Rails 项目的一部分在 GitHub 上下载。

许可证

Action Mailer 在 MIT 许可下发布

支持

API 文档位于:

Ruby on Rails 项目的错误报告可在此处提交:

功能请求应在此处的 rubyonrails-core 论坛上讨论: