【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】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