Webhook APIを使って添付ファイル付きメールを処理する(Azure Functions + C#)

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

  1. メール受信時
  2. メール送信時

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

<!—more—>

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

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

Webhook設定ダイアログ

Azure Functionsの準備

まずAzure Functionsにて関数を作成します。Azure FunctionsはVisual Studio Codeから作成できます。ウィザードに沿って進めていくだけで作成できるので簡単です。

今回は .NET6 を使い、HTTPトリガーを選択しています。また、ネームスペースは Smtps.Function で、関数名は CMCWebhook としています。

送信されてくるデータについて

メールを受信すると、以下のような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": "...."
}

関数を作成する

関数のベースは以下のようになります。レスポンスはJSONで、 {"result": "ok"} という文字列を返すようにしています。

using System;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;

namespace Smtps.Function
{
    public static class CMCWebhook
    {
        [FunctionName("CMCWebhook")]
        public static async Task<IActionResult> Run(
            [HttpTrigger(AuthorizationLevel.Function, "post", Route = null)] HttpRequest req,
            ILogger log)
        {

            return new ContentResult(){Content = "{\"result\": \"ok\"}", ContentType = "application/json"}; 
        }
    }
}

.NETのコード

以下のコードは、上記関数の内容です。

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

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

var form = await req.ReadFormAsync();
log.LogInformation(form["filter"])

添付ファイルの処理

添付ファイルの有無は form["attachments"] が0以上かどうかで判別できます。

添付ファイルは form.Files にてアクセスできます。1つ目の添付ファイルはインデックス0、2つ目はインデックス1になります。

var attachments = Int32.Parse(form["attachments"]);
if (attachments > 0)
{
        log.LogInformation(form.Files[0].FileName);
        log.LogInformation(form.Files[0].Length.ToString());
}

全体のコード

全体は以下のようなコードになります。

using System;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.Azure.WebJobs;
using Microsoft.Azure.WebJobs.Extensions.Http;
using Microsoft.AspNetCore.Http;
using Microsoft.Extensions.Logging;

namespace Smtps.Function
{
    public static class CMCWebhook
    {
        [FunctionName("CMCWebhook")]
        public static async Task<IActionResult> Run(
            [HttpTrigger(AuthorizationLevel.Function, "post", Route = null)] HttpRequest req,
            ILogger log)
        {
            var form = await req.ReadFormAsync();
            var attachments = Int32.Parse(form["attachments"]);
            log.LogInformation(form["attachments"].ToString());
            if (attachments > 0)
            {
                log.LogInformation(form.Files[0].FileName);
                log.LogInformation(form.Files[0].Length.ToString());
            }
            return new ContentResult(){Content = "{\"result\": \"ok\"}", ContentType = "application/json"}; 
        }
    }
}

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

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

Webhookログ

まとめ

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

添付ファイルまで処理対象にしたい時には、この方法を利用してください。

受信サーバ | Customers Mail Cloud