Webhook APIを使ってメールを処理する（GCP Functions + Python）

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

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

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

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

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

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

GCPの準備

まずGCPにて関数を作成します。

今回はウィザードの中で、Python3系を設定しています。ローカルで開発する際には functions-framework をインストールします。コードをGCPでインラインに書くこともできますが、今回はローカルにて開発しています。

関数を作成する

関数のベースは以下のようになります。ファイル名は main.py です。

from flask import jsonify

import functions_framework

@functions_framework.http
def hello_http(request):
    return jsonify({"result": "ok"})

この main.py を以下のように実行します。

functions-framework-python --target hello_http

これで http://localhost:8080/ を呼び出すと、hello_http 関数が実行されます。

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"
}

Pythonのコード

以下のコードは main.py の中身です。

POST時の処理について

処理は hello_http 関数の中に書きます。処理結果は {"result": ok} というJSONを返すだけとしています。

受け取ったデータは get_json メソッドでPythonのDictオブジェクトとして取得できます。

from flask import escape, jsonify

import functions_framework

@functions_framework.http
def hello_http(request):
    request_json = request.get_json(silent=True)
    print(request_json['filter'])
    return jsonify({"result": "ok"})