Webhook APIを使ってメールを処理する（ASP.NET編）

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

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

今回はASP.NET Coreを使ってメールを処理する流れを紹介します。

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

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

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

サーバ側のコード

ASP.NETで作ったサーバ側のコードは次のようになります。今回はControllersというフォルダを作成し、その中にMailController.csを作成しています。まず必要なライブラリを読み込みます。

namespace CMC.Controllers;

using Microsoft.AspNetCore.Mvc;
using CMC.Models;

次にWebhookを受け取るクラスMailControllerを定義します。

[ApiController]
public class MailController : Controller
{
    [HttpPost("mails")]
    public async Task<IActionResult> Post([FromBody] InputData data)
    {
        Console.WriteLine(data.filter);
        Console.WriteLine(data.envelopeFrom);

        // 処理が成功した場合は200 OKを返す
        return new OkResult();
    }
}

さらにこのコントローラーを読み込むための指定を Program.cs に追加しています。

app.MapControllerRoute(
    name: "default",
    pattern: "{controller=Home}/{action=Index}/{id?}");

モデルの定義

Models フォルダを作成し、その中に InputData.cs を追加しています。

namespace CMC.Models;

using System;
using System.Text.Json.Serialization;

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 CMC.Models;

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

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

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