Webhook APIを使ってメールを処理する（Deno Deploy）

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

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

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

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

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

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

Deno Deployの準備

今回はローカルで開発する流れを紹介します。Denoのインストールは行っている前提とします。その上で、任意のフォルダを作成します。

mkdir cmc_demo
cd cmc_demo

そして、 main.ts というファイルを作成します。

import { serve } from "https://deno.land/std@0.140.0/http/server.ts";

serve(async (_req) => {
    try {
        return new Response("ok", { status: 200 });
    } catch (error) {
        return new Response("Invalid request", { status: 400 });
    }
});

実行する際には、下記コマンドを実行します。

deno run --watch --allow-net main.ts

これで、 http://localhost:8000 にてサーバーが立ち上がります。

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

TypeScriptのコード

処理は main.ts に記述します。

import { serve } from "https://deno.land/std@0.140.0/http/server.ts";

serve(async (_req) => {
    try {
        // ここに処理を記述します
        return new Response("ok", { status: 200 });
    } catch (error) {
        return new Response("Invalid request", { status: 400 });
    }
});

まず、送られてくるデータに合わせて型を定義します。

export interface JsonParams {
  filter: string
  headers: Header[]
  subject: string
  "envelope-to": string
  server_composition: string
  html: string
  text: string
  "envelope-from": string
}

export interface Header {
  name: string
  value: string
}

送られてくるデータは await _req.json() で受け取れます。これを JsonParams 型にキャストしています。

const params = await _req.json() as JsonParams;

後は、このオブジェクトから必要な情報を取り出して処理を行います。

console.log(params.filter); // info@smtps.jp
console.log(params.subject); // Webhookのテスト

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

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

まとめ

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

受信サーバ | Customers Mail Cloud