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を書き換えるか否かを判定するための設定

autobahn MTAが受け取るメールのエンベロープFROMにこの項目で指定した値が含まれていた場合、エンベロープFROMをautobahn MTA由来のものに書き換えます。
エンベロープFROMを書き換えない場合、別途バウンスメールを受け取るための受信用メールサーバが必要です。
全てのメールのエンベロープFROMをautobahn 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"}}