ニフクラAPI (ESS: SetIdentityDkimEnabled)

【重要なお知らせ】サービス統合に基づくサービス名称の読み替えのお願い（2024年4月1日）

2024年4月1日をもって、「ニフクラ」は、「FJcloud-V」に統合し、名称を変更しました。
当サイトのアドレス（ドメイン名）に含まれる「nifcloud.com」は現時点では変更はございませんが、
各ページに記載の「ニフクラ」「NIFCLOUD」「nifcloud」は、「FJcloud-V」に読み替えていただきますようお願いいたします。

ニフクラユーザーガイド

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

SetIdentityDkimEnabled

処理概要

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

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

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

指定するパラメーター

パラメーター	型	説明	必須
DkimEnabled	string	メール送信時にDKIM署名を行うかどうか値: true (有効) false (無効) 使用可能文字: true,1(有効) \| false,0(無効)	○
Identity	string	設定対象のID 使用可能文字: ドメインまたはメールアドレス	○

応答フィールド

フィールド (項目)	型	説明
SetIdentityDkimEnabledResponse	structure	ルート
␣SetIdentityDkimEnabledResult	string	結果
␣ResponseMetadata	structure	共通メタ情報
␣␣RequestId	string	リクエスト識別子

エラー

コード	タイプ	HTTPステータスコード	説明
ValidationError	Sender	400	パラメーターが不正です。
InvalidParameterValue	Sender	400	無効な値または範囲外の値を入力パラメーターに指定しています。
MalformedInput	Sender	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.nifcloud.com
Content-type: application/x-www-form-urlencoded
X-Nifty-Date: 20140320T112311Z
Content-Length: 43

Action=SetIdentityDkimEnabled&DkimEnabled=true&Identity=localpart%40example.com&Version=2010-12-01N2014-05-28

応答サンプル

    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>