【Rails】「mailcatcher」を使ってテストメールを送信/受信する

2021年3月12日 12:36

はじめに

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

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

オプション 説明
--ip IP smtp/httpサーバーのIPアドレスを設定
--smtp-ip IP smtpサーバーのIPアドレスを設定
--smtp-port PORT smtpサーバーのポート番号を設定
--http-ip IP httpサーバーのIPアドレスを設定
--http-port PORT httpサーバーのポート番号を設定
--[no-]growl メッセージを受信したらローカルマシンに通知
-f, --foreground フォアグラウンドで実行
-b, --browse ウェブブラウザを開く
-v, --verbose 詳細を表示
-h, --help ヘルプ情報を表示

テストメールを受信

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

まとめ

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

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

関連記事

【Rails】GitHubのセキュリティアラートで発見された脆弱性を解消する方法
# はじめに GitHubにはセキュリティアラートという機能があります。セキュリティアラートはリポジトリに含まれるライブラリやパッケージの脆弱性を定期的にチェックし、脆弱性のあるライブラリやパッケージが発見されたらアラートで知らせてくれるという機 [...]
2022年1月16日 10:36
【Rails】devise-two-factorを使った2段階認証の実装方法【初学者】
# はじめに Railsアプリで2段階認証を実装するには、「rotp」というGemを使う方法の他に、「devise-two-factor」というGemを使う方法があります。「devise-two-factor」はその名の通り、IDとパスワードによ [...]
2021年12月12日 17:58
【Rails】rotpを使った2段階認証の実装方法【初学者】
# はじめに 昨今はIDとパスワードによる認証だけでなく、ワンタイムパスワードによる2段階認証を導入するWebアプリが増えてきました。Railsで作成したWebアプリでも、IDとパスワードによる認証に加えて2段階認証を導入するニーズが高まっていま [...]
2021年11月27日 13:02
【Rails】deviseを使った認証機能の実装【初学者】
# はじめに Railsアプリに認証機能を導入するには「devise」というGemを使う方法が最も簡単です。「devise」は認証に係る機能をほとんどコードを書くことなく実装できる反面、処理がブラックボックス化されており、全容が把握しづらいという [...]
2021年11月27日 13:01
【Rails】IDとパスワードによる認証機能の実装【初学者】
# はじめに 大抵のWebアプリでは、ユーザー登録/解除、ログイン/ログアウトといった認証機能を持っています。Railsには簡単に認証機能を導入できる「device」というGemが用意されています。「devise」は多くのRailsアプリで使われ [...]
2021年11月27日 13:00