本文へジャンプします。

ニフティクラウド APIリファレンス

クラウド トップ>API>ESS>SetIdentityDkimEnabled

ESS:SetIdentityDkimEnabled

概要

指定した送信元IDに対して、そこから送信する電子メールにDKIM署名を行うか行わないかを設定する。

  • 有効にするIDがドメイン(例:example.com)の場合、そのドメインのメールアドレス(例:user@example.com)から送るすべての電子メールに署名を行います。
  • 有効にするIDがメールアドレスの場合、そのメールアドレスから送るすべての電子メールに署名を行います。

電子メールアドレスの場合には、あらかじめ、VerifyDomainDkimアクションを使用してアドレスが所属するドメインに対してDKIM認証の設定を済ませておく必要があります。

リクエストパラメーター

要素名 説明 必須 最大値 デフォルト値 備考
DkimEnabled DKIM署名を有効にするかどうか。
(true|1:有効、 false|0:無効)
文字列  
Identity 設定対象のID(ドメインまたはメールアドレス) 文字列  

レスポンス

要素名 説明 備考
SetIdentityDkimEnabledResponse ルート  
SetIdentityDkimEnabledResult 結果  
ResponseMetadata 共通メタ情報  

エラー

エラー種別 HTTPステータスコード 説明
ValidationError 400 パラメーターが不足です。
InvalidParameterValue 400 無効な値または範囲外の値を入力パラメーターに指定しています。
MalformedInput 400 パラメーターが不正です。

サンプル

リクエストサンプル
POST / HTTP/1.1
Authorization: NIFTY4-HMAC-SHA256 Credential=<Credential>/20140320/east-1/email/nifty4_request, SignedHeaders=content-type;host;x-nifty-date, Signature=<Signature>
Host: ess.api.cloud.nifty.com
Content-type: application/x-www-form-urlencoded; charset=utf-8
X-Nifty-Date: 20140320T112311Z
Content-Length: 43

Action=SetIdentityDkimEnabled&DkimEnabled=true&Identity=localpart%40example.com&Version=2010-12-01
レスポンスサンプル
HTTP/1.1 200 OK
Date: Thu, 20 Mar 2014 11:23:11 GMT
x-amzn-RequestId: 5e84d51e-3050-4407-9517-3d6906d2f1de
X-Nifty-RequestId: 5e84d51e-3050-4407-9517-3d6906d2f1de
Content-Type: text/xml
Content-Length: 2494
Connection: close


<SetIdentityDkimEnabledResponse>
  <SetIdentityDkimEnabledResult/>
  <ResponseMetadata>
    <RequestId>ceb5ad65-caae-11e3-9c5d-d987248b6045</RequestId>
  </ResponseMetadata>
</SetIdentityDkimEnabledResponse>

推奨画面サイズ 1024×768 以上