Webhook APIを使ってメールを処理する（Rails編）

Customers Mail Cloudではプログラム側からデータを取得したり、メールを送信するWeb APIの他に、Customers Mail Cloudでメールを受信した時にイベントを伝えてくれるWebhook APIが用意されています。

Webhook APIを使うことで、自前でメールサーバを立てずにメール受信のタイミングでシステムを起動させられるようになります。メールサーバを安定して動作させ続けるのはメンテナンスコストが大きいですが、Customers Mail Cloudを使うことで簡単にメールと連携したシステムが作れるようになるでしょう。

今回はRuby on Railsを使ってメールを処理する流れを紹介します。

フォーマットはJSONとマルチパートフォームデータ

Webhookの形式として、JSONとマルチパートフォームデータ（multipart/form-data）が選択できます。この二つの違いは、添付ファイルがあるかどうかです。JSONの場合、添付ファイルは送られてきません。メールに添付ファイルがついてくる可能性がある場合は、後者を選択してください。

f:id:moongift:20200227212807p:plain — Webhook設定ダイアログ

今回はJSONフォーマットにおけるWebhook処理について紹介します。

サーバ側のコード

サーバ側のコードでは、まず受け取るコントローラ（今回はContactsController）のメソッドだけCSRFを解除します。

protect_from_forgery only: :webhook

そして config/routes.rb にルーティングを追加します。

Rails.application.routes.draw do
    # 追加
  post 'webhook', to: 'contacts#webhook', as: 'webhook'
end

app/controllers/contacts_controller.rb のwebhookメソッドではparamsでWebhookの内容を受け取れます。

def webhook
    logger.debug("件名: #{params["subject"]}")
    logger.debug("本文（テキスト）: #{params["text"]}")
    logger.debug("本文（HTML）: #{params["html"]}")
    logger.debug("FROM: #{params["envelope-from"]}")
    logger.debug("TO: #{params["envelope-to"]}")
    head :ok
end

この実行結果は次のようになります。

件名: Webhookのテスト
本文（テキスト）: Webhookのテスト用メールです。
本文（HTML）: <div dir="ltr">Webhookのテスト用メールです。<div><br clear="all"><div><div dir="ltr" class="gmail_signature">...</div>
FROM: info@smtps.jp
TO: user@smtps.jp

実際に受け取る内容は次のようになります。

{
    "filter": "info@smtps.jp",
    "headers": [
      :
    ],
    "subject": "Webhookのテスト",
    "envelope-to": "user@smtps.jp",
    "server_composition": "sandbox",
    "html": "<div dir=\"ltr\">Webhookのテスト用メールです。<div>...</div></div>",
    "text": "Webhookのテスト用メールです。\r\n\r\n--\r\n...",
    "envelope-from": "info@smtps.jp"
}