ess / Client / get_identity_dkim_attributes

get_identity_dkim_attributes

ess.Client.get_identity_dkim_attributes(**kwargs)

指定した送信元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つ返却されます。

See also: NIFCLOUD API Documentation

Request Syntax

response = client.get_identity_dkim_attributes(
    Identities=[
        'string',
    ]
)
Parameters:

Identities (list) –

[REQUIRED]

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'DkimAttributes': [
        {
            'Key': 'string',
            'Value': {
                'DkimEnabled': True|False,
                'DkimTokens': [
                    'string',
                ],
                'DkimVerificationStatus': 'string'
            }
        },
    ],
    'ResponseMetadata': {
        'RequestId': 'string'
    }
}

Response Structure

  • (dict) –

    • DkimAttributes (list) –

      • (dict) –

        • Key (string) –

        • Value (dict) –

          • DkimEnabled (boolean) –

          • DkimTokens (list) –

            • (string) –

          • DkimVerificationStatus (string) –

    • ResponseMetadata (dict) –

      • RequestId (string) –