はじめに

Railsアプリでコンタクトフォームなどを自作している場合、開発段階でメールが送信されることを確認する必要があります。開発段階のテストのため、実際のメールサーバーを使うことや、実際のメールクライアントにテストメールが残ることを避けたいという場合があります。

本記事では、mailcatcherというGemを使ってテストメールサーバーを構築し、テストメールを送信する方法について説明します。

mailcatcherを使ってテストメールを送信／受信

mailcatcherのインストール

Railsアプリにmailcatcherをインストールするには、Gemfileに以下を追加し、bundle installを行います。mailcatcherは開発環境でのみ使用するので、developmentグループの中に追加します。

group :development do
  gem 'mailcatcher'
end

mailcatcherの設定

Railsアプリにmailcatcherを設定するには、config/environments/development.rbに以下を追記します。

  config.action_mailer.delivery_method = :smtp
  config.action_mailer.smtp_settings = { address: 'localhost', port: 1025 }

mailcatcherの実行

mailcatherを実行するには、コンソールで以下のコマンドを実行します。デフォルトではバックグラウンドで起動し、smtp://localhost:1025が使用されます。

$ mailcatcher

コマンド実行時、以下のオプションが設定できます。

テストメールを受信

開発環境のRailsアプリからテストメールを送信すると、mailcatcherでメールを受信します。メールボックスはhttp://localhost:1080で確認できます。

まとめ

開発環境でテストメールの確認ができるGemは他にletter_openerがありますが、mailcatcherのほうが導入も簡単ですし使い方も非常にシンプルなのでおすすめです。

本記事を参考にして、テストメールを送信／受信していただければと思います。