domains(DKIMドメイン)

domains

要素domainsについて説明します。

リクエスト時、domainsの要素内に、DKIM認証で利用するドメインの情報を記載します。
配列型であり、複数のdomain情報を同時に登録することが可能となります。

注意事項
一度のリクエストで指定可能な件数は、最大50件までです。
{
  "domains": [
    {
      "sign_domain": "example.com",
   "selector": "sample0001",
      "key_len": 1024,
      "start_date": "2021-07-01T00:00+09:00",
      "default": 0,
      "enable": true
    },
    {...},
    {...}
  ]
}

構成

リクエスト時に構成される要素は以下です。

sign_domain

DKIM署名で利用するドメインです。
署名ドメインは、メール送信時にヘッダーフロムとして指定するメールアドレスのドメインを指定します。
メール送信時に署名ドメインと一致したドメインを指定すると、DKIM署名は作成者署名として送信されます。

注意事項
DKIM署名は作成者署名でのご利用が基本となります。

異なるドメインを指定しますと、DKIMは第三者署名として送信されます。

補足説明
第三者署名で利用されるドメインについては後述します。

selector

DKIM情報をドメイン名との組み合わせで、一意に認識するためのラベルです。
リクエスト時、省略しての利用を推奨します。

リクエスト時に省略すると、弊社システムで生成した文字列を返却します。
同じ署名ドメインでも、異なるセレクタを指定することで、複数の認証情報を登録可能です。

注意事項
DNSに登録を完了後、ドメイン一覧取得APIにてステータスがOKとなっていることを確認頂き、ご利用ください。

key_len

署名時に利用する鍵の長さを指定します。リクエスト時、省略可能。
鍵長は、以下の二つから選択可能です。

  1. 1024
    1024bitの鍵長で生成します。省略時は1024bitで処理します。
  2. 2048
    2048bitの鍵長で生成します。
補足説明
数値が大きい方がセキュリティ強度は上がりますが、DNSの仕様で登録できなかったり、メール送信の性能が落ちるなどの短所もあるため、通常は1024bitを選択するようにしてください。

start_date

登録した署名ドメインの利用開始日を指定します。リクエスト時、省略可能。
利用開始日はセレクタ単位で設定します。省略時は、登録日時で設定されます。

default

登録した署名ドメインの第三者署名利用を指定します。リクエスト時、省略可能。
セレクタ単位で指定します。

  1. 0
    作成者署名として利用します。省略時は「0」で登録されます。
  2. 1
    第三者署名として利用します。

本設定を行なった場合、署名ドメインと合致しないFromドメインで配信した場合、指定された署名ドメインで署名し、配信を行います。

補足説明
ユーザーによる第三者署名利用の指定がない場合、弊社にて用意している署名ドメインにて署名が行われます。
注意事項
複数のセレクタを設定した場合、利用開始日の最も新しいセレクタが利用されます。
利用開始日も同一の場合には、どのセレクタが利用されるか不定となるため、ご注意ください。

enable

利用開始日以降に、署名ドメインの有効・無効を指定します。リクエスト時、省略可能。
セレクタ単位で指定します。

  1. true
    「有効」。省略時はtrueで登録されます。
  2. false
    「無効」
補足説明
利用開始日以前の場合、本設定で「有効」としても利用できません。