Webhook APIを使って添付ファイル付きメールを処理する（Google Cloud Functions + Ruby）

Customers Mail CloudのWebhookは2種類あります。

メール受信時
メール送信時

メール受信時のWebhookはその名の通り、メールを受け取った際に任意のURLをコールするものです。この記事では添付ファイル付きメールを受け取った際のWebhook処理について解説します。

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

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

送信されてくるデータについて

メールを受信すると、以下のようなWebhookが送られてきます（データは一部マスキングしています）。JSONにしていますが、実際にはmultipart/form-dataです。

{
    "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",
    "attachments": 1,
    "attachment1": "...."
}

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 でサーバーが立ち上がります。

Rubyのコード

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

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

マルチパートフォームデータを取得する

multipart/form-data で送られてくるデータは req.params にて受け取れます。

puts req.params["filter"]
puts req.params["subject"]

添付ファイルの処理

添付ファイルの有無は req.params["attachments"] が0以上かどうかで判別できます。

そして、添付ファイルは req.params["attachment1"] のようにしてアクセスできます。1つ目の添付ファイルはキーが attachment1 、2つ目は attachment2 になります。実際のデータは :tempfile にあります。

データが取り出せれば、後はファイルとして書き込んだり、解析を行えます。

if req.params["attachments"].to_i > 0
  attachment = req.params["attachment1"]
  filename = attachment[:filename]
  tempfile = attachment[:tempfile]
  target_path = File.join("uploads", filename)
      File.open(target_path, "wb") do |f|
    f.write(tempfile.read)
  end
end