Webhook APIを使って添付ファイル付きメールを処理する（ASP.NET編）

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

メール受信時
メール送信時

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

<!—more—>

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

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

ASP.NETによる実装

今回はASP.NETでWebhookを受け取った場合について解説します。 application/json を外した場合には multipart/form-data で送られてきます。この場合、以下のようにデータを受けます。

添付ファイルは attachment1 や attachment2 というパラメータ名で受け取ります。この数は添付ファイルの数によって動的に変わります。

namespace CMC.Controllers;

using Microsoft.AspNetCore.Mvc;
using CMC.Models;
using System.Text.Json;
using System.Collections.Generic;

// [ApiController]
public class MailController : Controller
{
    [HttpPost("mails")]
    public async Task<IActionResult> Post([FromForm] InputData data)
    {
        Console.WriteLine(data.filter);
        Console.WriteLine(data.envelopeFrom);
        Console.WriteLine(data.attachments);
        if (data.attachment1 != null)
        {
            Console.WriteLine(data.attachment1.FileName);
        }
        // 処理が成功した場合は200 OKを返す
        return new OkResult();
    }
}

ファイル名は以下のように取得できます。

Console.WriteLine(data.attachment1.FileName); // 画像1.jpg

クラスについて

InputData クラスは次のようになります。 attachment1 〜 attachment4 は必要に応じて用意してください。完全に可変の場合は、リクエストボディから変換する方法が良さそうです。

using System.Text.Json.Serialization;

namespace CMC.Models;

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; }
    public int attachments { get; set; } = 0;
    public IFormFile? attachment1 { get; set; }
    public IFormFile? attachment2 { get; set; }
    public IFormFile? attachment3 { get; set; }
    public IFormFile? attachment4 { get; set; }
}

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

namespace CMC.Models;

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

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

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