Name

filter

DKIM Signature Filter — Signs emails using DKIM signature algorithm

<filter class="xms.filter.dkim.DKIMSignatureFilter" />

Table 13. Attributes for filter tag (for xms.filter.dkim.DKIMSignatureFilter)

NameDescriptionTypeDefault ValueRequired
algorithmThe hashing algorithm used to generate the domain key signatureAlgorithm One of the following values: rsa-sha256,rsa-sha1rsa-sha256no
aliasDefines the key alias to use if aliasMethod="STATIC"String any character combinationnoneno
aliasMethodThe method used to choose the keystore aliasAliasMethod One of the following values: default,selector,static,domaindefaultno
canonicalizationAlgorithm used to prepare the message data for signingCanonicalization One of the following values: relaxed,simplesimpleno
domainListA domain list of domains to sign with this filterStringList Name of a StringList as defined in StringListServicenoneno
domainsA comma separated list of domains to use this key signature withString any character combinationnoneno
headersA comma separated list of headers to include in the signature. You may also use the value all, which signs all headers. Note that From is always included as required by the DKIM specificationString any character combinationThe recommended list of headers to include as specified in section 5.5 of RFC 4871no
keyStoreThe keystore containing the private key to sign the messages withKeyStore Name of a KeyStore as defined in KeyStoreServicenoneyes
queryMethodThe query method for the public key. Currently the only available query method is dns.QueryMethod One of the following values: dnsdnsno
selectorDefines the selector name to use if selectorMethod="STATIC"String any character combinationnoneno
selectorMethodThe method used to choose the selectorSelectorMethod One of the following values: staticstaticno

Service Dependencies

This tag depends on the following services (or a service that extends or implements these classes)

Example 14. Example configuration for DKIM Signature Filter

Required attributes are marked with a bold typeface

<filter class="xms.filter.dkim.DKIMSignatureFilter"
      algorithm="algorithm"
      alias="alias"
      aliasMethod="aliasMethod"
      canonicalization="canonicalization"
      domainList="domainList"
      domains="domains"
      headers="headers"
      keyStore="keyStore"
      queryMethod="queryMethod"
      selector="selector"
      selectorMethod="selectorMethod" />