【Rails】Action Mailerの基本情報と実装方法

はじめに

コンタクトフォームからお問い合わせ内容を送信したり、ブログに新着コメントがあったことを知らせる内容を送信したり、Railsアプリでメールを送信する必要のある場面は多いです。ActionMailerという機能を使えば簡単にメール送信機能が実装できます。ビューと同じようにレイアウトやテンプレートなども使えるので少し凝ったメールデザインにすることもできます。

本記事では、ActionMailerの使い方についてまとめています。

ActionMailerの基本

ActionMailerの作成

ActionMailerを作成するには、以下のコマンドを実行します。

$ rails generate mailer ContactMailer

上記コマンドを実行すると以下のファイルが作成されます。

  • app/mailer/contact_mailer.rb
  • app/views/contact_mailer/
  • test/mailers/contact_mailer_test.rb
  • test/mailers/previews/contact_mailer_preview.rb

ActionMailerの削除

ActionMailerを削除するには、以下のコマンドを実行します。

$ rails destroy mailer ContactMailer

ActionMailerの実装

メールを送信するには、メイラーアクションで送信先アドレスや件名などを設定し、メイラービューでメールデザインを作成します。処理の流れとしてはコントローラーとビューの関係によく似ています。

今回は例としてコンタクトフォームに入力されたお問い合わせ内容をメール送信する処理を作成します。

メイラーアクションの実装

まずメイラーアクションを実装します。コントローラーから渡されたパラメーターはメイラーアクション内でparamsハッシュから取得できます。mailメソッドで送信先アドレスと件名を設定し、メール送信処理が開始されます。

app/mailer/ディレクトリ配下のcontact_mailer.rbに以下を追記します。

class ContactMailer < ApplicationMailer
  # 以下を追記
  def send_mail
    @contact = params[:contact]

    app_name = Rails.application.class.parent_name
    mail(to: contact@example.com, subject: "【#{app_name}】新着のお問い合わせ")
  end
end

mailメソッドの引数でto(送信先アドレス)は設定していますがfrom(送信元アドレス)は設定していません。from(送信元アドレス)の設定はどこでしているかというと、application_mailer.rbで行っています。

class ApplicationMailer < ActionMailer::Base
  default from: 'from@example.com'
  layout 'mailer'
end

from(送信元アドレス)の設定を変更したい場合はこのapplication_mailer.rbを直接書き換えてもいいのですが、個別のメイラーアクションに書くことで設定を上書きすることができます。

class ContactMailer < ApplicationMailer
  # 以下を追記
  default from: 'no-reply@example.com',
          to: 'contact@example.com'

  def send_mail
    @contact = params[:contact]

    app_name = Rails.application.class.parent_name
    mail(subject: "【#{app_name}】新着のお問い合わせ")
  end
end

contact_mailer.rbfrom(送信元アドレス)を追記し、ついでにto(送信先アドレス)も移動しました。このように、mailerメソッドの引数はすべてメイラーアクション外のdefaultで設定することもできます。

メイラービューの実装

次にメイラービューを実装します。メイラービュー名はメイラーアクション名と同じにする必要があります。また、コントローラー同様、メイラーアクション内で定義した@付きの変数はメイラービュー内で使うことができます。

app/views/contact_mailer/ディレクトリ配下にsend_mail.html.erbを作成し、以下を記述します。これはHTMLメールのメイラービューになります。

<p><%= @contact.name %> (<%= @contact.email %>)</p>
<%= simple_format(@contact.content) %>

テキストメールのメイラービューも作成します。send_mail.text.erbを作成し、以下を記述します。

<%= @contact.name %> (<%= @contact.email %>)
<%= @contact.content %>

メイラービューは通常のビューと同じく、レイアウトとテンプレート(とパーシャル)から構成されます。メイラービューのデフォルトのレイアウトはapp/views/layouts/ディレクトリ配下のmailer.html.erbmailer.text.erbです。メイラービューのレイアウトでもyieldを使うことができます。

個別のレイアウトを使いたい場合は、ActionMailerと同じ名前のレイアウトファイルを作成します。ContactMailerの場合、レイアウト名はcontact_mailer.html.erbcontact_mailer.text.erbとなります。

サイト内リンクと画像の追加

ActionMailerは、HTTPに基づくホスト情報とは無関係です。ビューで使えるlink_toimage_tagはメイラービューでも使うことはできますが、HTTPに基づくホスト情報が使えないので、アプリケーション設定でホスト情報を明示しておく必要があります。

config/environments/ディレクトリ配下の環境毎の設定ファイルに以下を追記します。以下は開発環境の例です。本番環境は実際のホスト情報に書き換えてください。

config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
config.action_mailer.asset_host = 'http://localhost:3000'

これでメイラービューでサイト内リンクと画像が使えるようになりました。

<p>ログインは<%= link_to 'こちら', login_path %>からお願いします。</p>
<%= image_tag 'logo.png', alt: 'ロゴ画像' %>

コントローラーの実装

最後にコントローラーから実装済みのメール送信処理を呼び出します。今回はお問い合わせ内容のメール送信なので、コンタクトフォームからお問い合わせ内容が送信されたときのアクションに以下を追記します(関係ない箇所は省略しています)。

class ContactsController < ApplicationController
  def sending
    @contact = Contact.new(contact_params)
    if @contact.valid?
      # 以下を追記
      ContactMailer.send_mail(@contact).deliver_later

      redirect_to contact_done_path
    else
      redirect_to contact_path
    end
  end

  private
    def contact_params
      params.require(:contact).permit(:name, :email, :content)
    end
end

これでメールを送信する準備ができました。実際にメールを送信するにはさらにActionMailerの設定(SMTPなど)を行う必要があります。ActionMailerの設定については、後述の「ActionMailerの設定」セクションと「ActionMailerのテスト」セクションを参照してください。

ActionMailerの設定

ActionMailerの設定は環境毎に異なることが多いので、config/environments/ディレクトリ配下の環境毎の設定ファイルに記述します。以下はメールサーバーにGmailを使用する場合の例です。

config.action_mailer.delivery_method = :smtp
config.action_mailer.smtp_settings = {
  address: 'smtp.gmail.com',
  port: 587,
  domain: 'example.com',
  user_name: Rails.application.credentials.gmail[:user_name],
  password: Rails.application.credentials.gmail[:password],
  authentication: 'plain',
  enable_starttls_auto: true
}

ユーザー名とパスワードはCredentialsを使って設定します。Credentialsの使い方については以下の記事を参照してください。

ActionMailerのすべての設定項目を確認したい場合は以下のページを参照してください(config.action_mailerを検索)。

ActionMailerのテスト

ActionMailerのテストは大きく分けて2種類あります。1種類目は、メールが意図した通りのデザインになっているかの確認。これはメールのプレビューを使って確認します。2種類目は、メール送信処理がエラーなく動くかの確認。これはmailcatcherというGemを使って確認します。

デザインの確認

メールデザインの確認を行うには、メールのプレビュー機能を使います。ActionMailer作成コマンドを実行したときにプレビューファイルも作成されます。test/mailers/previews/ディレクトリ配下のcontact_mailer_preview.rbに以下を追記します。

class ContactMailerPreview < ActionMailer::Preview
  # 以下を追記
  def send_mail
    contact = Contact.new(name: 'テスト', email: 'test@example.com', content: 'テスト送信。')
    ContactMailer.send_mail(contact)
  end
end

あとはhttp://localhost:3000/rails/mailers/contact_mailer/send_mailにアクセスするだけでメールデザインを確認することができます。また、http://localhost:3000/rails/mailersにアクセスすればメールのプレビュー一覧を確認することができます。

送信処理の確認

メールが送信されることを確認する必要があるのですが、実際のメールサーバーを使いたくない場合があります。そんなときはmailcatcherというGemを使って確認を行います。mailcatcherの使い方については以下の記事を参照してください。

まとめ

Railsアプリであれば比較的簡単にコンタクトフォームを実装できてしまいます。ただし、自作のコンタクトフォームは英語のスパムが届くことがあるので、できれば対策を行ったほうがいいでしょう。英語のスパム対策については以下の記事を参照してください。

本記事を参考にして、ActionMailerの使い方を覚えていただければと思います。

関連記事

【Rails】Railsアプリのデバッグ《マルチデバイス篇》
# はじめに 近年のWebアプリはレスポンシブ対応が当たり前になっています。最低でもPCとスマートフォンに対応したデザイン、ときにはその中間のタブレットに対応したデザインなんかも作成する必要があります。 Webアプリの開発はPCを使って行う [...]
2021年5月23日 13:02
【Rails】Railsアプリのデバッグ《Better Errors篇》
# はじめに Railsアプリの開発中になんらかのエラーが発生すると、デフォルトでは以下のような画面が表示されます(画像をクリックすると拡大します)。 <a class="gallery" data-group="gallery" href [...]
2021年5月22日 19:42
【Rails】Railsアプリのデバッグ《byebug篇》
# はじめに Ruby on Railsに限りませんが、アプリの開発中にはエラーは付き物です。なにかしらのエラーが発生したときに、エラーの原因を特定しエラー箇所を修正することをデバッグと言います。Railsではデバッグの手助けとなる機能があらかじ [...]
2021年5月22日 15:30
【Rails】レンダリング(renderメソッド)でアンカー指定を行う
# はじめに 通常、Railsでアンカー付きのリクエストを発生させるには`redirect_to`を使います。 ```rb redirect_to root_path(anchor: 'target') ``` では、`rende [...]
2021年5月20日 10:47
【Rails】Bundler 2.2.x以降は開発者が適切なプラットフォームを追加する必要がある
# 事象 昔作ったRailsアプリを久しぶりに修正しデプロイしようとしたところ、以下のエラーが出力されました。 ```bash # 実行コマンド Running $HOME/.rbenv/bin/rbenv exec bundle ch [...]
2021年5月18日 16:18