【Rails】mailcatcherを使用して開発環境でメール送信をテストする方法

はじめに

mailcatcherは、開発環境でのメール送信をキャプチャするためのツールです。ローカルで送信されたメールをブラウザ上で簡単に確認できるようにします。mailcatcherをRailsアプリケーションで使用する方法について説明します。

mailcatcherの使用方法

Gemfileにmailcatcherを追加

まず、RailsアプリケーションのGemfileに以下を追記しbundle installを行います。

Gemfile

group :development do
  gem 'mailcatcher'
end

Railsアプリケーションのメール設定

mailcatcherを使用するために、Railsのメール設定を変更します。

config/environments/development.rb

Rails.application.configure do
  # 他の設定

  # MailCatcherの設定
  config.action_mailer.delivery_method = :smtp
  config.action_mailer.smtp_settings = {
    address: '127.0.0.1',
    port: 1025
  }

  # メールの送信元アドレスの設定(必要に応じて変更)
  config.action_mailer.default_url_options = { host: 'localhost', port: 3000 }
end

config.action_mailer.delivery_method:smtpに設定し、config.action_mailer.smtp_settingsでmailcatcherのSMTPサーバーを指定します。address: '127.0.0.1'port: 1025は、mailcatcherのデフォルトの設定です。

mailcatcherの起動

次に、ターミナルで以下のコマンドを使用してmailcatcherを起動します。

% mailcatcher
Starting MailCatcher
==> smtp://127.0.0.1:1025
==> http://127.0.0.1:1080

smtp://127.0.0.1:1025はSMTPサーバーのアドレスとポートです。http://127.0.0.1:1080はmailcatcherのウェブインターフェースのアドレスです。

メールの送信と確認

mailcatcherが起動している状態で、Railsアプリケーションからメールを送信すると、mailcatcherのウェブインターフェースで受信したメールを確認できます。

例として、ユーザー登録時にウェルカムメールを送信するUserMailerクラスを作成します。

% rails generate mailer UserMailer

app/mailers/user_mailer.rb

class UserMailer < ApplicationMailer
  default from: 'no-reply@example.com'

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

コントローラーでメール送信

例として、UsersControllerでユーザーを作成した後にウェルカムメールを送信します。

app/controllers/users_controller.rb

class UsersController < ApplicationController
  def create
    @user = User.new(user_params)
    if @user.save
      UserMailer.welcome_email(@user).deliver_now
      redirect_to @user, notice: 'User was successfully created.'
    else
      render :new
    end
  end

  private

  def user_params
    params.require(:user).permit(:email, :password, :password_confirmation)
  end
end

まとめ

これで、開発環境でメールの送信と受信を簡単にキャプチャして確認する準備が整いました。mailcatcherを使用することで、開発中に送信されるメールを実際に送信せずにテストすることができます。

関連記事

【Rails】Paranoiaを使用した論理削除(ソフトデリート)
# はじめに Paranoiaは、Railsアプリケーションで論理削除(ソフトデリート)を実現するためのGemです。 論理削除は、データベースのレコードを物理的に削除するのではなく、削除フラグを設定することで「削除済み」とみなす方法です。こ [...]
2024年7月20日 21:33
【Rails】activerecord-multi-tenantを使用したマルチテナントアプリケーションの作成
# はじめに マルチテナントアプリケーションでは、複数の顧客(テナント)が同じアプリケーションを利用するため、データの分離が必要です。 activerecord-multi-tenantは、このようなマルチテナント環境をサポートするための便 [...]
2024年7月18日 16:50
【Rails】RubyとRailsにおけるattr_reader, attr_writer, attr_accessorの概念と使用方法
# はじめに RubyとRailsの開発において、`attr_reader`,`attr_writer`,`attr_accessor`は非常に便利なメソッドです。これらは、クラス内でインスタンス変数に対するゲッターおよびセッターメソッドを簡単に [...]
2024年7月17日 18:11
【Rails】RubyとRailsにおけるyieldの概念と使用方法
# はじめに RubyとRailsにおける`yield`は、メソッドやテンプレートの中で動的にコードブロックを実行する能力を提供し、これによってコードの再利用性と拡張性が大幅に向上します。本記事では、RubyとRailsにおける`yield`の概 [...]
2024年7月17日 13:15
【Rails】AASMを使用してオブジェクトの状態遷移を効率的に管理
# はじめに Railsアプリケーションにおいて、オブジェクトの状態管理は重要な課題の一つです。AASM (Acts As State Machine) gemは、複雑な状態遷移を効率的に管理します。本記事では、AASMの基本的な使い方を解説して [...]
2024年7月16日 18:00
【Rails】RSpec + Swagger + rswagでアプリケーションのAPIをテストおよびドキュメント化する方法
# はじめに Railsアプリケーションの開発において、APIのテストとドキュメント化は重要な要素です。 RSpecはテストフレームワークとして広く利用されており、SwaggerはAPIの設計とドキュメント化を支援します。これらを統合するr [...]
2024年7月16日 14:27
【Rails】impressionistを使用してページビューやクリック数を追跡する方法
# はじめに impressionist Gemを使用してRailsアプリケーションでページビューやクリック数を追跡する方法について説明します。 # 実装方法 ## impressionist Gemのインストール まず、impre [...]
2024年7月15日 14:18
【Rails】meta-tagsを使用したメタタグの管理
# はじめに RailsアプリケーションでSEO対策を行うために、meta-tags Gemを使用してメタタグを管理する方法について説明します。 # メタタグの管理 ## meta-tags Gemのインストール まず、meta-t [...]
2024年7月15日 13:47