SMTP認証キー登録

SMTPリレーを利用するための認証キーを登録する。

既に上限数（10個）登録されている場合はエラーとなる。

リクエスト

エンドポイント

/v1/smtp/authorizations

HTTPメソッド

POST

リクエストボディ

JSON形式であること

要素名	型	要素数	制限	説明
name	文字列	1	英数字記号日本語問わず256文字まで既に登録されているnameは利用できない	SMTPリレーを利用するためのユーザ名後で変更することはできない
enable	boolean	0:1	true にすることで利用可能になるデフォルトは false	SMTP認証キーの有効性を設定する
replace_pattern	文字列	0:1	英数字記号日本語問わず256文字まで	エンベロープFROMを書き換えるか否かを判定するための設定 @utobahn-MTAが受け取るメールのエンベロープFROMにこの項目で指定した値が含まれていた場合、エンベロープFROMを@utobahn-MTA由来のものに書き換えるエンベロープFROMを書き換えない場合、別途バウンスメールを受け取るための受信用メールサーバが必要となる全てのメールのエンベロープFROMを@utobahn-MTA由来のものに書き換えたい場合、@ を設定することを推奨

リクエストボディサンプル

{
"name":"user",
"enable":true,
"replace_pattern":"@"
}

レスポンス

ステータスコード

状態	コード
成功	200
リクエストボディがjsonではない	400
jsonリクエストのバリデーションエラー	400
認証失敗	401
登録上限数制限などで登録に失敗した	403
存在しないエンドポイント	404
許可されていないHTTPメソッド	405
システムエラーが発生した	500
システムが一時的にサービスを提供できない状態になっている	503
システムのタイムアウト	504

レスポンスボディ

成功

replace_patternが設定されていない場合、項目自体がレスポンスボディに含まれない

{
"code":200,
"data":{
"head":"b3ph",
"id":1,
"name":"user",
"replace_pattern":"@"
"status":"ENABLE",
"tail":"aQXk",
"token":"b3pha2l0xxxxxxxxxxFzRGhJxxxxxxJ4SWxYSFF0xxxxxxxxxxh2ZUdaQXk"
}
}

失敗

{"code":400,"data_error":{"data":"invalid format"}}

{"code":400,"validation_errors":{"name":"must not be empty"}}

{"code":403,"data_error":{"data":"too many"}}

{"code":409,"data_error":{"data":"user is duplicated"}}