Enforced TLS

Enforced TLS設定は受信者側にTLSおよび適切な証明書を要求するか否かを指定します。詳細についてはSMTP Ports User Guideを参照してください。

TLSおよび適切な証明書を要求する設定になっているにもかかわらず受信側が条件を満たしていない場合、SendGridはメッセージをブロックして「TLS required but not supported」という説明のついたブロックイベントを通知します。

GET

現在のEnforced TLS設定を取得します。

Request

1

GET https://api.sendgrid.com/v3/user/settings/enforced_tls HTTP/1.1

Response

1
2
3
4
5

HTTP/1.1 200
{
    "require_tls": true,
    "require_valid_cert": false
}

PATCH

Enfoced TLS設定を編集します。

URI引数 必須 条件 説明
require_tls No trueまたはfalse 受信側にTLSサポートを要求します
require_valid_cert No trueまたはfalse 適切な証明書を要求します
version No 1.1, 1.2, 1.3のうちのいずれか 受信側に要求するTLSの最小バージョン（例：「1.2」を指定すると、TLS 1.2以上を要求する）

Request

1

PATCH https://api.sendgrid.com/v3/user/settings/enforced_tls HTTP/1.1
Request Body
1
2
3
4
5

{
  "require_tls": true,
  "require_valid_cert": true,
  "version": 1.1
}

Response

1
2
3
4
5
6

HTTP/1.1 200
{
    "require_tls": true,
    "require_valid_cert": true,
    "version": 1.1
}