Webhook APIを使ってメールを処理する（Google Cloud Functions + Ruby）

Ruby Google Cloud Functions 技術情報

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

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

今回はGoogle Cloud Functionsで、Rubyを使ってメールを処理する流れを紹介します。

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

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

Webhook設定ダイアログ

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

Google Cloud Functionsの準備

今回はローカルで開発する流れを紹介します。まず、適当なフォルダを作成します。今回はcmcとします。

mkdir cmc
cd cmc

そして Gemfile というファイルを作成し、以下のように記述します。

# frozen_string_literal: true

source "https://rubygems.org"

# gem "rails"
gem "functions_framework"

そしてライブラリをインストールします。

bundle install

次に app.rb というファイルを作成します。以下は空の内容ですが、後で処理を記述します。

#== app.rb ==#

require "functions_framework"
require "json"

FunctionsFramework.http "cmc" do |req|
  # この中に処理を記述します
  "Hello, Customers Mail Cloud!"
end

そして、以下のようにコマンドを実行します。

bundle exec functions-framework-ruby --source=app.rb --target=cmc

これで http://localhost:8080 でサーバーが立ち上がります。

Webhookで受け取るデータについて

Webhookを使ってPOSTされるJSONデータは、次のようになっています。

{
    "filter": "info@smtps.jp",
    "headers": [
      {"name": "Return-Path", "value": "<user@example.com>"},
        :
      {"name": "Date", "value": "Thu, 27 Apr 2023 15:56:26 +0900"}
    ],
    "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"
}

Rubyのコード

処理は app.rb の FunctionsFramework.http ブロック内に記述します。

FunctionsFramework.http "cmc" do |req|
  # この中に処理を記述します
  "Hello, Customers Mail Cloud!"
end

送られてくるデータは req.body.read で受け取れます。この内容はJSON文字列なので、 JSON.parse を使ってハッシュに変換します。

params = JSON.parse(req.body.read)

後は、このハッシュから必要な情報を取り出して処理を行います。

puts params["filter"] # info@smtps.jp
puts params["subject"] # Webhookのテスト

Webhookの結果は管理画面で確認

Webhookでデータが送信されたログは管理画面で確認できます。送信時のAPIキー設定など、HTTPヘッダーを編集するといった機能も用意されていますので、運用に応じて細かなカスタマイズが可能です。

Webhookログ

まとめ

メールと連携したシステムはよくあります。通常、メールサーバを立てて、その中で処理することが多いのですが、メールサーバが落ちてしまうとシステムが稼働しなくなったり、メール文面の解析が煩雑でした。Customers Mail Cloudを使えばそうした手間なくJSONで処理できて便利です。

受信サーバ | Customers Mail Cloud