Webhook APIを使ってメールを処理する(AWS Lambda + Ruby)

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

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

今回はAmazon Web Services(AWS)で、Ruby(3.2)を使ってメールを処理する流れを紹介します。

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

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

Webhook設定ダイアログ

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

AWSの準備

まずAWSにてLambdaの関数を作成します。

今回はウィザードの中でAPI GatewayのHTTPエンドポイントを設定しています。

ローカルで開発する際にはAWS CLIAWS SAM CLIをインストールします。また、Dockerのインストールも必要です。

AWSのIAMでLambdaの操作ができるユーザーを作成したら、aws configure コマンドでAPIキーを設定します。

関数を作成する

関数のベースは次のコマンドで作成できます。

$ sam init --runtime ruby3.2  

そしてローカルで関数を実行します。

$ sam local start-api

これで http://localhost:3000 で関数を呼び出せます。

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 の中身です。

POST時の処理について

処理は lambda_handler 関数の中に書きます。処理結果は ok という文字列を返すだけとしています。

body キーの内容をJSON.parseすれば、オブジェクトとしてデータを扱えます。

require 'json'

def lambda_handler(event:, context:)
  json = JSON.parse(event['body'], symbolize_names: true)
  puts "body: #{json[:filter]}"
  {
    statusCode: 200,
    body: {
      message: "ok",
    }.to_json
  }
end

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

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

Webhookログ

まとめ

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

受信サーバ | Customers Mail Cloud