Webhook APIを使ってメールを処理する（Java/Spring Framework編）

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

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

今回はJavaとSpring Frameworkを使ってメールを処理する流れを紹介します。

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

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

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

サーバ側のコード

Javaで作ったサーバ側のコードは次のようになります。まずHelloController.javaで必要なライブラリを読み込みます。

package com.example.springboot;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.http.HttpEntity;

次にWebhookを受け取る関数を定義します。今回はデフォルトで定義されているHelloControllerの中に POST /mails を定義しています。

@RestController
public class HelloController {

    @GetMapping("/")
    public String index() {
        return "Greetings from Spring Boot!";
    }

    @PostMapping("mails")
    @ResponseBody
    public String index(@RequestBody InputData input) {
        // ここで処理
        return "ok";
    }
}

InputDataクラスは次のように定義しています。

package com.example.springboot;

import java.util.HashMap;
import com.fasterxml.jackson.annotation.JsonProperty;

public class InputData {
    @JsonProperty("envelope-from")
    public String envelope_from;
    @JsonProperty("envelope-to")
    public String envelope_to;
    public String filter;
    public MailHeader[] headers;
    public String html;
    public String server_composition;
    public String subject;
    public String text;
}

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

package com.example.springboot;

public class MailHeader {
    public String name;
    public String value;
}

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

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