関連サイト: 関連URL

Action Mailer の基礎

本章では、アプリケーションでメールの送受信を行えるようにするために必要なすべての事項と、Action Mailerのさまざまな内部情報を提供します。また、メイラーのテスト方法についても説明します。

このガイドの内容:

1 はじめに

Action Mailerを使用することで、アプリケーションのメイラークラスやビューでメールを送信することができます。メイラーの動作はコントローラときわめて似通っています。メイラーはActionMailer::Baseを継承し、app/mailersに配置され、app/viewsにあるビューと結び付けられます。

2 メールを送信する

このセクションでは、メイラーとビューの作成方法を手順を追って説明します。

2.1 メイラー生成の全手順

2.1.1 メイラーを作成する
$ bin/rails generate mailer UserMailer
create  app/mailers/user_mailer.rb
create  app/mailers/application_mailer.rb
invoke  erb
create    app/views/user_mailer
create    app/views/layouts/mailer.text.erb
create    app/views/layouts/mailer.html.erb
invoke  test_unit
create    test/mailers/user_mailer_test.rb
create    test/mailers/previews/user_mailer_preview.rb

# app/mailers/application_mailer.rb
class ApplicationMailer < ActionMailer::Base
  default from: "from@example.com"
  layout 'mailer'
end

# app/mailers/user_mailer.rb
class UserMailer < ApplicationMailer
end

上に示したとおり、Railsの他のジェネレータ同様の方法でメイラーを生成できます。メイラーは概念上コントローラと似通っており、メイラーを生成すると (コントローラと同様に) ビューのディレクトリとテストも同時に生成されます。

ジェネレータを使用したくない場合は、app/mailersディレクトリ以下にファイルを作成し、ActionMailer::Baseを継承してください。

class MyMailer < ActionMailer::Base
end

2.1.2 メイラーを編集する

メイラーはRailsのコントローラと非常に似通っています。メイラーには「アクション」と呼ばれるメソッドがあり、メールのコンテンツを構成するのにビューを使用します。コントローラでHTMLなどのメールコンテンツを生成して顧客に送信したい場合、その箇所でメイラーを使用して、送信したいメッセージを作成します。

app/mailers/user_mailer.rbには空のメイラーがあります。

class UserMailer < ApplicationMailer
end

welcome_emailという名前のメソッドを追加し、ユーザーが登録したメールアドレスにメールを送信できるようにしてみましょう。

class UserMailer < ApplicationMailer
  default from: 'notifications@example.com'

  def welcome_email(user)
    @user = user
    @url  = 'http://example.com/login'
    mail(to: @user.email, subject: 'Welcome to My Awesome Site')
  end
end

上のメソッドで使用されている項目について簡単に説明します。利用可能なすべてのオプションについては、「Action Mailerの全メソッド」セクションでユーザー設定可能な属性を参照してください。

  • default Hash - メイラーから送信するあらゆるメールで使用されるデフォルト値のハッシュです。上の例の場合、:fromヘッダーにこのクラスのすべてのメッセージで使用する値を1つ設定しています。この値はメールごとに上書きすることもできます。
  • mail - 実際のメール・メッセージです。ここでは:toヘッダーと:subjectヘッダーを渡しています。

コントローラの場合と同様、メイラーのメソッド内で定義されたすべてのインスタンス変数はそのままビューで使用できます。

2.1.3 メイラービューを作成する

app/views/user_mailer/ディレクトリでwelcome_email.html.erbというファイルを1つ作成してください。このファイルを、HTMLでフォーマットされたメールテンプレートにします。

<!DOCTYPE html>
<html>
  <head>
    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
  </head>
  <body>
    <h1><%= @user.name %>様、example.comへようこそ。</h1>
      <p>
      example.comへのサインアップが成功しました。
      your username is: <%= @user.login %>.<br>
    </p>
    <p>
      このサイトにログインするには、<%= @url %>をクリックしてください。
    </p>
    <p>ご入会ありがとうございます。どうぞお楽しみくださいませ。</p>
  </body>
</html>

続いて、同じ内容のテキストメールも作成しましょう。顧客によってはHTMLフォーマットのメールを受け取りたくない人もいるので、テキストメールも作成しておくのが最善です。これを行なうには、app/views/user_mailer/ディレクトリでwelcome_email.text.erbというファイルを以下の内容で作成してください。

<%= @user.name %>様、example.comへようこそ。
===============================================

example.comへのサインアップが成功しました。ユーザー名は「<%= @user.login %>」です。

このサイトにログインするには、<%= @url %>をクリックしてください。

本サイトにユーザー登録いただきありがとうございます。

現在のAction Mailerでは、mailメソッドを呼び出すと2種類のテンプレート (テキストおよびHTML) があるかどうかを探し、multipart/alternative形式のメールを自動生成します。

2.1.4 メイラーを呼び出す

Railsのメイラーは、ビューのレンダリングと本質的に同じことを行っています。ビューのレンダリングではHTTPプロトコルとして送信されますが、メイラーではメールのプロトコルを経由して送信する点のみが異なります。従って、ユーザー作成に成功したときにメールを送信するようコントローラからメイラーに指示するだけで機能するようになります。

メイラー呼び出しは非常に簡単です。

例として、最初にscaffoldでUserを作成してみましょう。

$ bin/rails generate scaffold user name email login
$ bin/rails db:migrate

説明用のユーザーモデルを作成したので、続いてapp/controllers/users_controller.rbを編集し、新規ユーザーの保存成功直後にUserMailerUserMailer.welcome_emailを使用してそのユーザーにメールが送信されるようにしましょう。

Action MailerはActive Jobとうまく統合されているので、Webのリクエスト/レスポンスサイクルの外で非同期にメールを送信できます。このおかげで、ユーザーは送信完了を待つ必要がありません。

class UsersController < ApplicationController
  # POST /users
  # POST /users.json
  def create
    @user = User.new(params[:user])

    respond_to do |format|
      if @user.save
        # 保存後にUserMailerを使用してwelcomeメールを送信
        UserMailer.welcome_email(@user).deliver_later

        format.html { redirect_to(@user, notice: 'ユーザーが正常に作成されました。') }
        format.json { render json: @user, status: :created, location: @user }
      else
        format.html { render action: 'new' }
        format.json { render json: @user.errors, status: :unprocessable_entity }
      end
    end
  end
end

Active Jobはデフォルトでジョブを':inline'で実行します。したがって、この時点でdeliver_laterを使用してメールを送信できます。また、メールを後でバックグラウンドジョブから送信したい場合は、SidekiqやResqueなどのバックエンドクエリシステムを使用するようActive Jobを設定するだけで済みます。

メールをcronjobなどから今すぐ送信したい場合は、deliver_nowを呼び出すだけで済みます。

class SendWeeklySummary
  def run
    User.find_each do |user|
      UserMailer.weekly_summary(user).deliver_now
    end
  end
end

このwelcome_emailメソッドはActionMailer::MessageDeliveryオブジェクトを1つ返します。このオブジェクトは、そのメール自身が送信対象であることをdeliver_nowdeliver_laterに伝えます。ActionMailer::MessageDeliveryオブジェクトは、Mail::Messageをラップしています。内部のMail::Messageオブジェクトの表示や変更などを行いたい場合は、ActionMailer::MessageDeliveryオブジェクトのmessageメソッドにアクセスします。

2.2 ヘッダーの値を自動エンコードする

Action Mailerは、メールのヘッダーや本文のマルチバイト文字を自動的にエンコードします。

別の文字セットを定義したい場合や、事前に手動で別のエンコードを行っておきたい場合などの複雑な事例については、Mailライブラリを参照してください。

2.3 Action Mailerの全メソッド

以下の3つのメソッドを使用すれば、ほとんどのメール送信をカバーできます。

  • headers - メールに追加したいヘッダーを指定します。メールヘッダーのフィールド名と値のペアをハッシュにまとめて渡すこともできますし、headers[:field_name] = 'value'のように呼び出すこともできます。
  • attachments - メールにファイルを添付します。attachments['file-name.jpg'] = File.read('file-name.jpg')のように記述します。
  • mail - 実際のメール自身を送信します。このメソッドにはヘッダーのハッシュをパラメータとして渡すことができます。メソッドを呼び出すと、定義しておいたメールテンプレートに応じて、プレーンテキストメールまたはマルチパートメールを送信します。
2.3.1 ファイルを添付する

Action Mailerではファイルを簡単に添付できます。

  • ファイル名とコンテンツを渡すと、Action MailerとMail gemが自動的にmime_typeを推測し、エンコードを設定してファイルを添付します。

    attachments['filename.jpg'] = File.read('/path/to/filename.jpg')
    
    

mailメソッドをトリガーすると、マルチパート形式のメールが1つ送信されます。送信されるメールは、トップレベルがmultipart/mixedで最初のパートがmultipart/alternativeという正しい形式でネストしている、プレーンテキストメールまたはHTMLメールです。

メールに添付されるファイルは自動的にBase64でエンコードされます。他のエンコードを使用したい場合、事前に好みのエンコードを適用したコンテンツをHashでエンコードしてからattachmentsに渡します。

  • ヘッダーとコンテンツを指定してファイル名を渡すと、それらの設定がAction MailerとMailによって使用されます。

    encoded_content = SpecialEncode(File.read('/path/to/filename.jpg'))
    attachments['filename.jpg'] = {
      mime_type: 'application/x-gzip',
      encoding: 'SpecialEncoding',
      content: encoded_content
    }
    
    

エンコーディングの種類を指定すると、Mailはコンテンツが既にエンコード済みであると判断し、Base64によるエンコードを行いません。

2.3.2 ファイルをインラインで添付する

Action Mailer 3.0はファイルをインライン添付できます。この機能は3.0より前に行われた多数のハックを基に、理想に近づけるべくシンプルな実装にしたものです。

  • インライン添付を使用することをMailに指示するには、Mailer内のattachmentsメソッドに対して#inlineを呼び出すだけで済みます。

    def welcome
      attachments.inline['image.jpg'] = File.read('/path/to/image.jpg')
    end
    
    
  • 続いて、ビューでattachmentsをハッシュとして参照し、表示したい添付ファイルを指定することができます。これを行なうには、attachmentsに対してurlを呼び出し、その結果をimage_tagメソッドに渡します。

    <p>Hello there, this is our image</p>
    
    <%= image_tag attachments['image.jpg'].url %>
    
    
  • これはimage_tagに対する標準的な呼び出しであるため、画像ファイルを扱う時と同様、添付URLの後にもオプションのハッシュを1つ置くことができます。

    <p>こんにちは、以下の写真です。</p>
    
    <%= image_tag attachments['image.jpg'].url, alt: 'My Photo', class: 'photos' %>
    
    
2.3.3 メールを複数の相手に送信する

1つのメールを複数の相手に送信することももちろん可能です (サインアップが新規に行われたことを全管理者に通知するなど)。これを行なうには、メールのリストを:toキーに設定します。メールのリストの形式は、メールアドレスの配列でも、メールアドレスをカンマで区切った文字列でも構いません。

class AdminMailer < ActionMailer::Base
  default to: Proc.new { Admin.pluck(:email) },
          from: 'notification@example.com'

  def new_registration(user)
    @user = user
    mail(subject: "New User Signup: #{@user.email}")
  end
end

CC (カーボンコピー) やBCC (ブラインドカーボンコピー) アドレスを指定する場合にも同じ形式を使用できます。それぞれ:ccキーと:bccキーを使用します。

2.3.4 メールアドレスを名前で表示する

受信者のメールアドレスをメールにそのまま表示するのではなく、受信者の名前で表示したいことがあります。これを行なうには、メールアドレスを"フルネーム <メールアドレス>"の形式で指定します。

def welcome_email(user)
  @user = user
  email_with_name = %("#{@user.name}" <#{@user.email}>)
  mail(to: email_with_name, subject: 'Welcome to My Awesome Site')
end

2.4 メイラーのビュー

メイラーのビューはapp/views/name_of_mailer_classディレクトリに置かれます。個別のメイラービューは、その名前がメイラーメソッドと同じになるので、クラスから認識できます。先の例の場合、welcome_emailメソッドで使用するメイラービューは、HTML版であればapp/views/user_mailer/welcome_email.html.erbが使用され、プレーンテキストであればwelcome_email.text.erbが使用されます。

アクションで使用するデフォルトのメイラービューを変更するには、たとえば以下のようにします。

class UserMailer < ApplicationMailer
  default from: 'notifications@example.com'

  def welcome_email(user)
    @user = user
    @url  = 'http://example.com/login'
    mail(to: @user.email,
         subject: 'Welcome to My Awesome Site',
         template_path: 'notifications',
         template_name: 'another')
  end
end

上のコードは、anotherという名前のテンプレートをapp/views/notificationsディレクトリ以下から探索します。template_pathにはパスの配列を指定することもできます。この場合探索は配列順に沿って行われます。

より柔軟性の高い方法を使用したい場合は、ブロックを1つ渡して特定のテンプレートをレンダリングしたり、テンプレートを使用せずにインラインまたはテキストでレンダリングすることもできます。

class UserMailer < ApplicationMailer
  default from: 'notifications@example.com'

  def welcome_email(user)
    @user = user
    @url  = 'http://example.com/login'
    mail(to: @user.email,
         subject: 'Welcome to My Awesome Site') do |format|
      format.html { render 'another_template' }
      format.text { render text: 'Render text' }
    end
  end
end

上のコードは、HTMLの部分を'another_template.html.erb'テンプレートを使用してレンダリングし、テキスト部分を:textでレンダリングしています。レンダリングのコマンドはAction Controllerで使用されているものと同じなので、:text:inlineなどのオプションもすべて同様に使用できます。

2.5 Action Mailerのレイアウト

メイラーもコントローラのビューと同様の方法でレイアウトを設定できます。メイラーで使用するレイアウト名はメイラーと同じ名前である必要があります。たとえば、user_mailer.html.erbuser_mailer.text.erbというレイアウトは自動的にメイラーでレイアウトとして認識されます。

別のレイアウトファイルを明示的に指定したい場合は、メイラーでlayoutを呼び出します。

class UserMailer < ApplicationMailer
  layout 'awesome' # awesome.(html|text).erbをレイアウトとして使用する
end

コントローラのビューと同様に、yieldを使用してレイアウト内のビューをレンダリングできます。

formatブロック内でrenderメソッド呼び出しにlayout: 'layout_name'オプションを渡すことで、フォーマットごとに異なるレイアウトを指定することもできます。

class UserMailer < ApplicationMailer
  def welcome_email(user)
    mail(to: user.email) do |format|
      format.html { render layout: 'my_layout' }
      format.text
    end
  end
end

上のコードは、HTMLの部分についてはmy_layout.html.erbレイアウトファイルを明示的に使用してレンダリングし、テキストの部分については通常のuser_mailer.text.erbがあればそれを使用してレンダリングします。

2.6 Action MailerのビューでURLを生成する

メイラーがコントローラと異なる点のひとつは、メイラーのインスタンスはサーバーに届くHTTPリクエストのコンテキストと無関係であることです。アプリケーションのホスト情報をメイラー内で使用したい場合は:hostパラメータを明示的に指定します。

:hostに指定する値はそのアプリケーション内で共通であるのが普通なので、config/application.rbに以下の記述を追加してグローバルに利用できるようにします。

config.action_mailer.default_url_options = { host: 'example.com' }

*_pathヘルパーは、動作の性質上メール内では一切使用できない点にご注意ください。メールでURLが必要な場合は*_urlヘルパーを使用してください。以下に例を示します。

<%= link_to 'ようこそ', welcome_path %>

上のコードの代りに、以下のコードを使用する必要があります。

<%= link_to 'ようこそ', welcome_url %>

こうすることでフルパスのURLが引用され、メールのURLが正常に機能するようになります。

2.6.1 url_forを使用してURLを生成する

テンプレートでurl_forを使用して生成されるURLはデフォルトでフルパスになります。

:hostオプションをグローバルに設定していない場合は、url_for:hostオプションを明示的に渡す必要があることにご注意ください。

<%= url_for(host: 'example.com',
            controller: 'welcome',
            action: 'greeting') %>

2.6.2 名前付きルーティングを使用してURLを生成する

メールクライアントはWebサーバーのコンテキストから切り離されているので、メールに記載するパスではWebのアドレスのベースURLは補完されません。従って、名前付きルーティングヘルパーについても "_path" ではなく "_url" を使用する必要があります。

:hostオプションをグローバルに設定していない場合は、"*_url" ヘルパーに:hostオプションを明示的に渡す必要があることにご注意ください。

<%= user_url(@user, host: 'example.com') %>

2.7 マルチパートメールを送信する

あるアクションに複数の異なるテンプレートがあると、Action Mailerによって自動的にマルチパート形式のメールが送信されます。UserMailerを例にとって説明します。app/views/user_mailerディレクトリにwelcome_email.text.erbwelcome_email.html.erbというテンプレートがあると、Action MailerはそれぞれのテンプレートからHTMLメールとテキストメールを生成し、マルチパート形式のメールとしてひとつにまとめて自動的に送信します。

マルチパートメールに挿入されるパートの順序はActionMailer::Base.defaultメソッドの:parts_orderによって決まります。

2.8 メール送信時に配信オプションを動的に変更する

SMTP認証情報などのデフォルトの配信オプションをメール配信時に上書きしたい場合、メイラーのアクションでdelivery_method_optionsを使用して変更することができます。

class UserMailer < ApplicationMailer
  def welcome_email(user, company)
    @user = user
    @url  = user_url(@user)
    delivery_options = { user_name: company.smtp_user,
                         password: company.smtp_password,
                         address: company.smtp_host }
    mail(to: @user.email,
         subject: "添付の利用規約を参照してください", 
         delivery_method_options: delivery_options)
  end
end

2.9 テンプレートをレンダリングせずにメール送信する

メール送信時にテンプレートのレンダリングをスキップしてメール本文を単なる文字列にしたくなることがあります。このような場合には:bodyオプションを使用できます。このオプションを使用する場合は、必ず:content_typeオプションも指定してください。指定しなかった場合はデフォルトのtext/plainが適用されます。

class UserMailer < ApplicationMailer
  def welcome_email(user, email_body)
    mail(to: user.email,
         body: email_body,
         content_type: "text/html",
         subject: "レンダリングしました")
  end
end

3 メールを受信する

Action Mailerを使用するメールの受信と解析は、メール送信に比べてやや複雑です。Railsアプリケーションでメールを受信できるようにするためには、その前にメール受信待ちするRailsアプリケーションに何らかの形でメールが転送されるようにしておく必要があります。Railsアプリケーションでメールを受信できるようにするためには、以下の作業が必要になります。

  • メイラーにreceiveメソッドを実装する

  • /(アプリのパス)/bin/rails runner 'UserMailer.receive(STDIN.read)'でメールを受信するアプリケーションに、メールサーバーからメールを転送する。

いずれかのメイラーにreceiveメソッドを定義すると、受信した生のメールはAction Mailerによって解析され、emailオブジェクトに変換されてデコードされた後、メイラーが新たにインスタンス化され、そのメイラーのreceiveインスタンスメソッドに渡されます。以下に例を示します。

class UserMailer < ApplicationMailer
  def receive(email)
    page = Page.find_by(address: email.to.first)
    page.emails.create(
      subject: email.subject,
      body: email.body
    )

    if email.has_attachments?
      email.attachments.each do |attachment|
        page.attachments.create({
          file: attachment,
          description: email.subject
        })
      end
    end
  end
end

4 Action Mailerのコールバック

Action Mailerではbefore_actionafter_actionおよびaround_actionというコールバックを指定できます。

  • コントローラと同様、メイラークラスのメソッドにもフィルタ付きのブロックまたはシンボルを1つ指定することができます。

  • before_actionコールバックを使用してmailオブジェクトにデフォルト値やdelivery_method_optionsを与えたり、デフォルトのヘッダと添付を挿入することもできます。

  • after_actionコールバックもbefore_actionと同様の設定を行いますが、メイラーのアクション内のインスタンス変数を使用します。

class UserMailer < ApplicationMailer
  after_action :set_delivery_options,
               :prevent_delivery_to_guests,
               :set_business_headers

  def feedback_message(business, user)
    @business = business
    @user = user
    mail
  end

  def campaign_message(business, user)
    @business = business
    @user = user
  end

  private

    def set_delivery_options
      # ここではメールのインスタンスや
      # @businessや@userインスタンス変数にアクセスできる
      if @business && @business.has_smtp_settings?
        mail.delivery_method.settings.merge!(@business.smtp_settings)
      end
    end

    def prevent_delivery_to_guests
      if @user && @user.guest?
        mail.perform_deliveries = false
      end
    end

    def set_business_headers
      if @business
        headers["X-SMTPAPI-CATEGORY"] = @business.code
      end
    end
end

  • メールのbodyにnil以外の値が設定されている場合、Mailer Filtersは処理を中止します。

5 Action Mailerヘルパーを使用する

Action MailerはAbstractControllerを継承しているので、Action Controllerと同様に一般的なヘルパーメソッドを使用できます。

6 Action Mailerを設定する

以下の設定オプションは、environment.rbやproduction.rbなどの環境設定ファイルのいずれかで使用するのが最適です。

設定 説明
logger 可能であればメール送受信に関する情報を生成します。nilを指定するとログ出力を行わなくなります。Ruby自身のLoggerロガーおよびLog4rロガーのどちらとも互換性があります。
smtp_settings :smtpの配信メソッドの詳細設定を行います。
  • :address - リモートのメールサーバーの使用を許可する。デフォルトは"localhost"であり、必要に応じて変更する。
  • :port - メールサーバーが万一ポート25番で動作していない場合はここで変更する。
  • :domain - HELOドメインを指定する必要がある場合はここで行なう。
  • :user_name - メールサーバーで認証が必要な場合はここでユーザー名を指定する。
  • :password - メールサーバーで認証が必要な場合はここでパスワードを指定する。
  • :authentication - メールサーバーで認証が必要な場合はここで認証の種類を指定する。:plain:login:cram_md5のいずれかのシンボルを指定する。
  • :enable_starttls_auto - 自力では解決できない証明書問題が発生している場合はfalseを指定する。
sendmail_settings :sendmailの配信オプションを上書きします。
  • :location - sendmailの実行可能ファイルの場所を指定する。デフォルトは/usr/sbin/sendmail
  • :arguments - sendmailに渡すコマンドライン引数を指定する。デフォルトは-i -t
raise_delivery_errors メール配信に失敗した場合にエラーを発生するかどうかを指定します。このオプションは、外部のメールサーバーが即時配信を行っている場合にのみ機能します。
delivery_method 配信方法を指定します。以下の配信方法を指定可能です。
  • :smtp (default) -- config.action_mailer.smtp_settingsで設定可能。
  • :sendmail -- config.action_mailer.sendmail_settingsで設定可能。
  • :file: -- メールをファイルとして保存する。config.action_mailer.file_settingsで設定可能。
  • :test: -- メールを配列ActionMailer::Base.deliveriesに保存する。
詳細についてはAPIドキュメントを参照。
perform_deliveries Mailのメッセージにdeliverメソッドを実行したときに実際にメール配信を行なうかどうかを指定します。デフォルトでは配信が行われます。機能テストなどで配信を一時的にオフにしたい場合に便利です。
deliveries delivery_method :testを使用してAction Mailerから送信されたメールの配列を保持します。単体テストおよび機能テストで最も便利です。
default_options mailメソッドオプション (:from:reply_toなど)のデフォルト値を設定します。

設定オプションの完全な説明については「Railsアプリケーションを設定する」ガイドのAction Mailerを設定するを参照してください。

6.1 Action Mailerの設定例

適切なconfig/environments/$RAILS_ENV.rbファイルに追加する設定の例を以下に示します。

config.action_mailer.delivery_method = :sendmail
# デフォルトは以下のとおりです。
# config.action_mailer.sendmail_settings = {
#   location: '/usr/sbin/sendmail',
#   arguments: '-i -t'
# }
config.action_mailer.perform_deliveries = true
config.action_mailer.raise_delivery_errors = true
config.action_mailer.default_options = {from: 'no-reply@example.com'}

6.2 Gmail用のAction Mailer設定

Action MailerにMail gemが導入されたので、config/environments/$RAILS_ENV.rbファイルの設定は以下のように非常に簡単になりました。

config.action_mailer.delivery_method = :smtp
config.action_mailer.smtp_settings = {
  address:              'smtp.gmail.com',
  port:                 587,
  domain:               'example.com',
  user_name:            '<ユーザー名>',
  password:             '<パスワード>',
  authentication:       'plain',
  enable_starttls_auto: true  }

7 メイラーのテスト

メイラーのテスト方法の詳細についてはテスティングガイドのメイラーをテストするを参照してください。

8 メールを配信直前に加工する

メールを配信する前に何らかの編集を加えたいことがあります。幸い、Action Mailerにはすべてのメールの配信前に処理を加えるためのフックが提供されています。これを使用して、メールが配信エージェントに最終的に渡される直前にメールの内容を変更するためのインターセプタを登録することができます。

class SandboxEmailInterceptor
  def self.delivering_email(message)
    message.to = ['sandbox@example.com']
  end
end

インターセプタが動作するようにするには、Action Mailerフレームワークに登録する必要があります。これは、以下のようにイニシャライザファイルconfig/initializers/sandbox_email_interceptor.rbで行います。

ActionMailer::Base.register_interceptor(SandboxEmailInterceptor) if Rails.env.staging?

上の例では"staging"というカスタマイズした環境を使用しています。これは本番 (production環境) に準じた状態でテストを行うための環境です。Railsのカスタム環境についてはRails環境を作成するを参照してください。

フィードバックについて

本ガイドは GitHub上の yasslab/railsguides.jp で管理・公開されております。 本ガイドを読んで気になる文章や間違ったコードを見かけたら、上記リポジトリにてお気軽に Issue を出して頂けると嬉しいです。また、「Pull Request を送りたい!」という場合には、Ruby on Railsガイドのガイドラインと、READMEに記載されている「翻訳の流れ」をご参考にしてください。

なお、原著における間違いを見つけたら、「Ruby on Railsに貢献する方法」に記されているRailsのドキュメントに貢献するを参考にしながら、ぜひRailsコミュニティに貢献してみてしてください :)

本ガイドの品質向上に向けて、皆さまのご協力が得られれば幸いです。よろしくお願い致します。

  1. Star
  2. このエントリーをはてなブックマークに追加