本文へジャンプします。

ニフクラ ユーザーガイド

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

GetIdentityDkimAttributes

処理概要

指定した送信元ID(メールアドレスまたはドメイン)のDKIM署名に関連する設定情報を返します。

IDがドメインもしくはドメインが設定済みのメールアドレスの場合には、追加情報としてEasy DKIM署名を行うために必要なDKIMトークン一式およびトークンの検証結果を返します。

このアクションは、IDのリストを受け取り、それぞれのIDに関する次の情報を返します。
・現在メール送信時にEasy DKIMで署名する設定になっているかどうか。
・そのIDの身元をあらわすDKIMトークン一式。
 - IDが電子メールアドレスの場合にはトークンはそのアドレスのドメインの身元をあらわしています。
・発行したDKIMトークンが、正しくDNSサーバに設定されていることをニフクラ ESSが検証できたかどうか。
 - IDがドメインもしくはドメインが設定済みのメールアドレスの場合のみ返します。

DKIMトークンについて

ドメインの身元をあらわす文字列です。
これらのトークンを使用して、DKIM公開鍵を置いてあるニフクラ ESSのホストに転送するようにDNS CNAMEレコードを定義する必要があります。

DNS更新後、72時間以内にDNSレコードが更新されたことを検出します。
検出に成功すると、ニフクラ ESSからDKIM署名メールを送信可能になります。
各ドメインにつき、トークンは3つ所持しているので、レスポンス(XML)では、常にmemberは3つ返却されます。

指定するパラメーター

パラメーター 説明 必須
Identities.member.n string IDのリスト。
使用可能文字: nは1〜100までで必要な件数まで設定できる。
値はドメイン形式もしくはメールアドレス形式で指定する。

応答フィールド

フィールド (項目) 説明
GetIdentityDkimAttributesResponse structure ルート
GetIdentityDkimAttributesResult structure 結果
DkimAttributes list IDのDKIM関連属性情報のリスト
entry structure IDのDKIM関連属性情報
key string ID(ドメイン名もしくはメールアドレス)
value structure 属性情報
DkimEnabled boolean メール送信時にDKIM署名を行うかどうか
値:
  • true(正常)
  • false(異常)
DkimVerificationStatus string 発行したDKIMトークンが正しくDNSサーバに設定されていることをニフクラ ESSが検証できたかどうか
値:
  • Pending (検証中)
  • Success (成功)
  • Failed (失敗)
  • TemporaryFailure (一時的な障害)
  • NotStarted (検証開始前)
DkimTokens structure

DKIMトークンのリスト。
IDがドメインもしくはドメインが設定済みのメールアドレスの場合のみ出力。


member string DKIMトークン
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=GetIdentityDkimAttributes&Identities.member.1=example1.com&Identities.member.2=example2.com&Identities.member.3=localpart%40example3.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

<GetIdentityDkimAttributesResponse>
  <GetIdentityDkimAttributesResult>
    <DkimAttributes>
      <entry>
        <key>example1.com</key>
        <value>
          <DkimEnabled>true</DkimEnabled>
          <DkimVerificationStatus>Success</DkimVerificationStatus>
          <DkimTokens>
            <member>tj6yxtr62htt6hyurcp7m5lmgglvieoo</member>
            <member>lst5xr73xxppufshu43us5abys5v3p6z</member>
            <member>w4jfvxqvwln6dlw7cze7o45addmrjxs4</member>
          </DkimTokens>
        </value>
      </entry>
      <entry>
        <key>example2.com</key>
        <value>
          <DkimEnabled>true</DkimEnabled>
          <DkimVerificationStatus>Success</DkimVerificationStatus>
          <DkimTokens>
            <member>qoicdpre7wihhrummt5yp2zk6nqq6yhg</member>
            <member>ao4ijunpyewmegjvgopmuy5ar525mbjo</member>
            <member>2kwj26nl4ozw7heh66aaacbns3sq5aei</member>
          </DkimTokens>
        </value>
      </entry>
      <entry>
        <key>localpart@example3.com</key>
        <value>
          <DkimEnabled>false</DkimEnabled>
          <DkimVerificationStatus>NotStarted</DkimVerificationStatus>
        </value>
      </entry>
    </DkimAttributes>
  </GetIdentityDkimAttributesResult>
  <ResponseMetadata>
    <RequestId>46232c8e-d0cd-11e3-b109-c1e64412a5f3</RequestId>
  </ResponseMetadata>
</GetIdentityDkimAttributesResponse>

  
  • ※本ページ記載の金額は、すべて税抜表示です。
  • ※本ページ記載の他社製品名および会社名などは、各社の商標または登録商標です。
  • ※本ページの内容は、2021年9月17日時点の情報です。

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