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

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

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

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

<!—more—>

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

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

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が送られてきます（データは一部マスキングしています）。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": "...."
}

Pythonのコード

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

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

multipart/form-data で送られてくるデータは request.form にて取得できます。これは Dict になっており、キーを指定してデータを取得できます。

request_args = request.form
print(request_args['filter'])

添付ファイルの処理

添付ファイルの有無は request_args['attachments'] が0以上かどうかで判別できます。なお、日本語のファイル名はエンコードされているので注意してください。

添付ファイルは request.files にてアクセスできます。1つ目の添付ファイルは attachment1 、2つ目は attachment2 といった形になります。

if int(request_args['attachments']) > 0:
        print(request.files['attachment1'].filename)

全体のコード

main.py は以下のようなコードになります。

from flask import escape, jsonify

import functions_framework

@functions_framework.http
def hello_http(request):
    request_args = request.form
    # request_args['filter'] などでアクセス可能
    if int(request_args['attachments']) > 0:
              # 添付ファイルあり
        print(request.files['attachment1'].filename)
    return jsonify({"result": "ok"})