【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】ダウンロードしたフリーフォントをWebpackerを使って導入する方法
# はじめに Webサイトのデザインを彩るひとつの要素にフォントの種類があります。Google Fontsの登場により、様々なフォントが手軽に導入できるようになりました。しかし、世の中にはGoogle Fontsが提供するフォント以外にもたくさん [...]
2021年10月16日 13:26
【Rails】mimemagicに依存しているRailsアプリでbundle installコマンドが失敗する事象の対処法
# はじめに Railsアプリで`bundle install`コマンドを実行しようとしたところ、以下のエラーメッセージが出力されコマンドに失敗しました。 ``` Your bundle is locked to mimemagic (0 [...]
2021年10月14日 14:44
【Rails】macOSのアップデート後にrailsコマンドが失敗する事象の対処法
# はじめに 久しぶりにRailsアプリに手を入れようと思い、`rails server`コマンドを実行してRailsサーバーを立ち上げようとしたところ、エラーが出て起動に失敗してしまいました。 前回までの間にしたことの中で思い当たることと [...]
2021年10月14日 12:11
【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