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: '[email protected]'

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

电子邮件的主体是使用 Action View 模板（常规的 ERB）创建的，该模板具有在邮件程序操作中声明的实例变量。

因此，上面方法的相应主体模板可能如下所示

Hello there,

Mr. <%= @recipient %>

Thank you for signing up!

如果收件人设置为“[email protected]”，则生成的电子邮件将如下所示

Date: Mon, 25 Jan 2010 22:48:09 +1100
From: [email protected]
To: [email protected]
Message-ID: <[email protected]>
Subject: [Signed up] Welcome [email protected]
Mime-Version: 1.0
Content-Type: text/plain;
    charset="US-ASCII";
Content-Transfer-Encoding: 7bit

Hello there,

Mr. [email protected]

Thank you for signing up!

为了发送邮件，您只需调用该方法，然后在返回值上调用 deliver_now。

调用该方法将返回一个 Mail 消息对象

message = Notifier.welcome("[email protected]")   # => Returns a Mail::Message object
message.deliver_now                                    # => delivers the email

或者，您也可以将这些方法链接在一起，例如

Notifier.welcome("[email protected]").deliver_now # Creates the email and sends it immediately

设置默认值

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

请注意，使用此方法设置的每个值都将在您在邮件程序方法中使用相同键时被覆盖。

示例

class AuthenticationMailer < ActionMailer::Base
  default from: "[email protected]", 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
}

下载和安装

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

$ gem install actionmailer

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

• github.com/rails/rails/tree/main/actionmailer

许可证

Action Mailer 在 MIT 许可证下发布

• opensource.org/licenses/MIT

支持

API 文档位于

• api.rubyonrails.org

Ruby on Rails 项目的错误报告可以在这里提交

• github.com/rails/rails/issues

功能请求应在以下位置的 rails-core 邮件列表中进行讨论

• discuss.rubyonrails.org/c/rubyonrails-core