SMTP認証キー更新

IDに対応するSMTP認証キーの情報を更新する。

リクエスト

エンドポイント

/v1/smtp/authorizations/[id]

HTTPメソッド

PUT

リクエストボディ

JSON形式であること

要素名
型
要素数
制限
説明
enable boolean 0:1

true にすることで利用可能になる
デフォルトは false

 SMTP認証キーの有効性を設定する
replace_pattern 文字列 0:1 英数字記号日本語問わず256文字まで

エンベロープFROMを書き換えるか否かを判定するための設定
@utobahn-MTAが受け取るメールのエンベロープFROMにこの項目で指定した値が含まれていた場合、エンベロープFROMを@utobahn-MTA由来のものに書き換える
エンベロープFROMを書き換えない場合、別途バウンスメールを受け取るための受信用メールサーバが必要となる
全てのメールのエンベロープFROMを@utobahn-MTA由来のものに書き換えたい場合、@ を設定することを推奨

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

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

レスポンス

ステータスコード
状態
コード
成功 200
クエリパラメータのバリデーションエラー 400
認証失敗 401
不正なイベントや存在しないイベント等の理由で削除に失敗した 403
存在しないエンドポイント 404
許可されていないHTTPメソッド 405
システムエラーが発生した 500
システムが一時的にサービスを提供できない状態になっている 503
システムのタイムアウト 504

レスポンスボディ

成功

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

失敗

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

{"code":404,"data_error":{"id":"999 not exists"}}