Rails6で導入されるAction Mailboxを試してみた

はじめに

新しい技術にチャレンジし続けるeishisのアドベントカレンダーDay15です！

昨日は3Dモデル制作の入門、またWebAR/WebVRに関する記事でした。

これから始める！3Dモデル制作

今回はRuby on Railsのバージョン6以降に取り組まれることが発表された、Action Mailboxの概要をご紹介します。

Action Mailboxとは

Ruby on Railsの公式ブログで2018年12月14日（日本時間）発表された、バージョン6で取り組こまれるメールの取扱に関するフレームワークです。

発表内容

既存のAction Mailerはメールの送信に関しての機能を持ちますが、Action Mailboxメールの受信に関してのフレームワークです。
メールの受信をRails側でキャッチし、DBに格納することができます。

まだバージョンも0.1.0ですが、少しだけその使い方などを先行してお伝えします。

実際に使ってみる

Ruby on Railsのバージョン6以降で正式に取り込まれますが、現在もGemとしてバージョン5.2以降で試すことができます。

リポジトリ に従って実際に試してみましょう。

まずはRails5のアプリケーションを作っていきます。
rails new _5.2.2_ action_mailbox_test -d mysql

Gemfileにactionmailboxを追加し、installしていきます。
gem "actionmailbox", github: "rails/actionmailbox", require: "action_mailbox"

bundle install

次にAction Mailboxのinstallコマンドを打ちます。
./bin/rails action_mailbox:install

[action_mailbox_test] ./bin/rails action_mailbox:install
Copying application_mailbox.rb to app/mailboxes
      create  app/mailboxes/application_mailbox.rb
Copied migration 20181214102213_create_active_storage_tables.active_storage.rb from active_storage
Copied migration 20181214102214_create_action_mailbox_tables.action_mailbox.rb from action_mailbox

application_mailbox.rb という設定ファイルとmigrationファイルが追加されます。

次にmigrateを行います。
./bin/rails db:migrate

メールサービスプロバイダ毎の設定（SendGrid）

Action MailboxはAmazon SES、Mailgun、Mandrill、Postfix、SendGridをサポートしています。
今回は私が個人的に好きなSendGridを使用していきます。

サービスプロバイダを指定

config/environments/production.rb

config.action_mailbox.ingress = :sendgrid

パスワード設定

次にAction Mailbox でSendGrid側から通信するパスワードを設定します。
Rails5.2で追加されたrails credentialsか環境変数のどちらかで設定します。

1　rails credentials を使う
rails credentials:edit コマンドで設定をします。

action_mailbox:
  ingress_password: password #パスワードを設定

2 環境変数設定をする
exportコマンドなどで設定をします。
export RAILS_INBOUND_EMAIL_PASSWORD =password

SendGridの設定をする

Inbound ParseにRailsのURLを設定するするのですが、その前にいくつか設定をしていきます。

まずSendGridに登録

こちらからSendGridにサービス登録します。

ドメインを追加

SettingｓのSender AuthenticationからDomain Authenticationを追加します。
CNAMEを3つ追加するようにと言われるので設定しましょう。

その後にverifyされたらドメイン準備はOKです。

Inbound Parseの設定

SettingsのInbound Parseから、設定をしていきます。
Hostは先程のドメインを設定します。
ここでポイントとなるのはDestination URLです。

以下の値を設定してください。パスワードは先ほど設定したパスワードです。
https://actionmailbox:<パスワード>@<ドメイン>/rails/action_mailbox/sendgrid/inbound_emails

ここまでで設定は完了です。

実際にメールをからRailsアプリを受け取る

では、実際にメールを受け取ってみましょう。
SendGridで指定したドメイン宛にメールを送ります。

すると、このようなログが流れます。

2018-12-15T08:55:19.070938+00:00 app[web.1]: I, [2018-12-15T08:55:19.070813 #4]  INFO -- : Processing by ActionMailbox::Ingresses::Sendgrid::InboundEmailsController#create as HTML
2018-12-15T08:55:19.071468+00:00 app[web.1]: I, [2018-12-15T08:55:19.071361 #4]  ...

Content preview:  これはAction Mailboxテストのめーるです。 [...]\n   \n\nContent analysis details:   (0.0 points, 5.0 required)\n\n pts rule name              description\n---- ---------------------- --------------------------------------------------\n\n", "envelope"=>"{\"to\":[\"toのアドレス\"],\"from\":\"fromのアドレス\"}", "subject"=>"test mail", "spam_score"=>"0", "charsets"=>"{\"to\":\"UTF-8\",\"subject\":\"UTF-8\",\"from\":\"UTF-8\"}", "SPF"=>"pass"}

色々と割愛していますが、このようにRails側でメール内容を受け取ることができました！

例えば自分たちのドメインを混ぜたリストにメール配信をし、それをトリガーに処理を行ったり、お問い合わせメールを分析するなど様々な使い方が可能です。
今までこういったInbound Emailについては自分たちで独自の実装を行っていたものを、今回Action Mailboxではだいぶ簡略化してくれています。

Postfixのようなメールサーバや、様々なメールサービスプロバイダを指定できるのは個人的には助かる機能だと感じます。

まとめ

今回はRails6で取り込まれるAction Mailboxについて簡単にご紹介しました。
取得した情報をDBに保存したり、転送や返信の設定など他にもオプションなどもサポートされていますので、そちらはまた別の機会にご紹介します。