Webhook APIを使って添付ファイル付きメールを処理する（Java/Spring Framework編）

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

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

今回はJavaとSpring Frameworkを使って、添付ファイル付きメールを処理する流れを紹介します。

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

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

サーバ側のコード

Djangoで作ったサーバ側のコードは次のようになります。まず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;
import org.springframework.web.multipart.MultipartFile;

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

@RestController
public class HelloController {

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

    @PostMapping("mails")
    @ResponseStatus(code = HttpStatus.OK, value = HttpStatus.OK)
    public void index(
        @RequestParam(value = "filter", defaultValue = "", required = true) String filter,
        @RequestParam(value = "subject", required = true) String subject,
    @RequestParam(value = "envelope-to", required = true) String envelope_to,
    @RequestParam(value = "server_composition", required = true) String server_composition,
    @RequestParam(value = "html", required = true) String html,
    @RequestParam(value = "text", required = true) String text,
    @RequestParam(value = "envelope-from", required = true) String envelope_from,
        @RequestParam(value = "headers", required = true) String headers,
        @RequestParam(value = "attachment1", required = false) MultipartFile multipartFile1,
        @RequestParam(value = "attachment2", required = false) MultipartFile multipartFile2
    ) {
        // ここで処理
        logger.info(filter);
        logger.info(subject);
        logger.info(envelope_to);
        logger.info(server_composition);
        logger.info(html);
        logger.info(text);
        logger.info(envelope_from);
        logger.info(headers);
        logger.info(multipartFile1.getOriginalFilename());
        if (multipartFile2 != null) {
            logger.info(multipartFile2.getOriginalFilename());
        }
    }
}

添付ファイルについて

添付ファイルは attachment1、 attachment2のように番号が振られています。そのため RequestParam を必要な分、定義しています。 requiredは false が良いでしょう。

送られてくるデータについて

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

{
    "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",
    "attachment1": ".....",
    "attachment2": "....."
}