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

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

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

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

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

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

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

Google Cloud Functionsの準備

今回はローカルで開発する流れを紹介します。まずFunction.csというファイルを作成し、内容を以下のように記述します。

using Google.Cloud.Functions.Framework;
using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;
using System;

namespace HelloWorld;

public class Function : IHttpFunction
{
    public async Task HandleAsync(HttpContext context)
    {
            // この中に処理を記述します

            await context.Response.WriteAsync("ok");
    }
}

次に、 HelloWorld.csproj というファイルを作成し、以下のように記述します。

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net6.0</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Google.Cloud.Functions.Hosting" Version="2.1.0" />
  </ItemGroup>
</Project>

これで準備は完了です。関数は以下のように実行します。

dotnet run

実行すると、 http://127.0.0.1:8080 でサーバーが立ち上がります。

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

namespace HelloWorld;

using System;
using System.Text.Json.Serialization;
using System.Collections.Generic;

public class InputData
{
    [JsonPropertyName("envelope-from")]
    public string? envelopeFrom { get; set; }
    [JsonPropertyName("envelope-to")]
    public string? envelopeTo { get; set; }
    public string? filter { get; set; }
    public List<MailHeader>? headers { get; set; }
    public string? html { get; set; }
    public string? server_composition { get; set; }
    public string? subject { get; set; }
    public string? text { get; set; }
}

MailHeader クラスは以下のようになります。

using System;
namespace HelloWorld;

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

POST時の処理について

POST時の処理は、次のようになります。JSONデータを受け取るには、 context.Request.ReadFromJsonAsync を使います。その際、レスポンスのクラスとして、先ほど定義した InputData を指定します。これによって、 data の内容は InputData として、プロパティへアクセスできます。

var data = await context.Request.ReadFromJsonAsync<InputData>();
Console.WriteLine(data?.filter);
Console.WriteLine(data?.envelopeFrom);

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

using Google.Cloud.Functions.Framework;
using Microsoft.AspNetCore.Http;
using System.Threading.Tasks;
using System;

namespace HelloWorld;

public class Function : IHttpFunction
{
    public async Task HandleAsync(HttpContext context)
    {
            var data = await context.Request.ReadFromJsonAsync<InputData>();
            Console.WriteLine(data?.filter);
            Console.WriteLine(data?.envelopeFrom);
      await context.Response.WriteAsync("ok");
    }
}