Inbound

Inbound Webhook は、受信したメールのヘッダおよびボディを解析し、 エンドポイントにHTTPリクエストでこれを通知します。 空メールやメールフォームなど受信したメールをシステムが処理するための インターフェイスとして使用することができます。


API設定

Inbound Webhook を利用するには管理コンソールからAPIを設定する必要があります。

ユーザーガイド→「API」→「Webhook」 を参照し、APIの設定を行ってください。


イベント

Inbound Webhookは、メールを受信した場合、以下のパラメータをエンドポイントにポストします。

パラメータ 必須 データ型 説明
api_key No ASCII 管理コンソールにてAPIキーの設定を行った場合、指定されたAPIキーを送信します。
server_composition Yes UTF-8 このイベントが発生したサーバ構成の名前を送信します。
filter Yes UTF-8 管理コンソールのWebhook→インバウンドで設定した受信通知名を送信します。
headers Yes UTF-8 受信したメールのヘッダをJSONフォーマットで送信します。
text No UTF-8 受信したメールのテキストボディを送信します。
html No UTF-8 受信したメールのHTMLボディを送信します。
subject Yes UTF-8 受信したメールの件名を送信します。
evnelope-from Yes ASCII 受信したメールのエンベローブFromを送信します。
evnelope-to Yes ASCII 受信したメールのエンベロープToを送信します。
attachments Yes INTEGER 受信したメールの添付ファイルの数を送信します。添付ファイルが存在しない場合、0です。
attachmentN No BINARY 受信したメールにファイルが添付されている場合、添付ファイルをファイルアップロード形式で送信します。パラメータ名 attachment の N は、添付ファイルのシーケンス番号です。シーケンス番号は0から始まり attachmens - 1で終わります。

headers パラメータのJSONフォーマットは、プロパティに name と value を持つオブジェクト のリストです。メールヘッダとその値をマッピングします。

[
    {
        "name" : "return-path",
        "value" : "bounce@hde.co.jp"
    },
    {
        "name" : "To",
        "value" : "receiver@hde.co.jp"
    },
    {
        "name" : "From",
        "value" : "sender@hde.co.jp"
    }
]
プロパティ 説明
name メールヘッダの名前
value メールヘッダの値