Webhook APIを使ってメールを処理する（Azure Functions + C#）

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

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

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

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

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

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

Azure Functionsの準備

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

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

関数を作成する

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

using System.IO;
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;
using Newtonsoft.Json;
using System.Collections.Generic;

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

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

C#のコード

まず、JSONデータを受け取るクラスを作成します。JSONデータのキー名と同じ名前のプロパティを作成します。JSONデータのキー名はスネークケースですが、C#のプロパティ名はキャメルケースにしています。

public class EmailHeader
{
    public string name { get; set; }
    public string value { get; set; }
}

public class Email
{
    public string filter { get; set; }
    public List<EmailHeader> headers { get; set; }
    public string subject { get; set; }
    [JsonProperty("envelope-to")]
    public string envelopeto { get; set; }
    public string server_composition { get; set; }
    public string html { get; set; }
    public string text { get; set; }
    [JsonProperty("envelope-from")]
    public string envelopefrom { get; set; }
}

POST時の処理について

POST時の処理は、次のようになります。JSONデータを受け取るには、 req.Body を読み込みます。JSONデータをデシリアライズするには、 JsonConvert.DeserializeObject を使います。

デシリアライズする際には Email クラスを指定します。 Email クラスには、JSONデータのキー名と同じ名前のプロパティが定義されていますので、自動的にデシリアライズされます。

var sr = new StreamReader(req.Body);
var email = JsonConvert.DeserializeObject<Email>(await sr.ReadToEndAsync());
log.LogInformation(email.subject);
log.LogInformation(email.filter);

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

using System.IO;
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;
using Newtonsoft.Json;
using System.Collections.Generic;

public class EmailHeader
{
    public string name { get; set; }
    public string value { get; set; }
}

public class Email
{
    public string filter { get; set; }
    public List<EmailHeader> headers { get; set; }
    public string subject { get; set; }
    [JsonProperty("envelope-to")]
    public string envelopeto { get; set; }
    public string server_composition { get; set; }
    public string html { get; set; }
    public string text { get; set; }
    [JsonProperty("envelope-from")]
    public string envelopefrom { get; set; }
}

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 sr = new StreamReader(req.Body);
            var email = JsonConvert.DeserializeObject<Email>(await sr.ReadToEndAsync());
            log.LogInformation(email.subject);
            log.LogInformation(email.filter);
            return new ContentResult(){Content = "{\"result\": \"ok\"}", ContentType = "application/json"}; 
        }
    }
}