Webhook APIを使ってメールを処理する（Python/Django編）

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

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

今回はPythonとDjangoを使ってメールを処理する流れを紹介します。

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

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

f:id:moongift:20200227212807p:plain — Webhook設定ダイアログ

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

サーバ側のコード

Djangoで作ったサーバ側のコードは次のようになります。まずurls.pyで必要なライブラリを読み込みます。

from django.http import HttpResponse
from django.views.decorators.csrf import csrf_exempt
import json

次にWebhookを受け取る関数を定義します。今回はjson_messageの中から主要な項目を出力しているだけです。なお、WebhookにはCSRFが含まれないので、@csrf_exempt を必ず付けておきます。

@csrf_exempt
def webhook(request):
    if request.method == 'POST':
        json_message = json.loads(request.body.decode('utf-8'))
        print(f'件名: {json_message["subject"]}')
        print(f'本文（テキスト）: {json_message["text"]}')
        print(f'本文（HTML）: {json_message["html"]}')
        print(f'FROM: {json_message["envelope-from"]}')
        print(f'TO: {json_message["envelope-to"]}')
        return HttpResponse("ok")

結果は次のようになります。

件名: Webhookのテスト
本文（テキスト）: Webhookのテスト用メールです。
本文（HTML）: <div dir="ltr">Webhookのテスト用メールです。<div><br clear="all"><div><div dir="ltr" class="gmail_signature">...</div>
FROM: info@smtps.jp
TO: user@smtps.jp

具体的なデータ構造は次のようになっています。

{
    "filter": "info@smtps.jp",
    "headers": [
      :
    ],
    "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"
}