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)
| Name | Description | Type | Default Value | Required |
|---|---|---|---|---|
| algorithm | The hashing algorithm used to generate the domain key signature | Algorithm One of the following values: rsa-sha256,rsa-sha1 | rsa-sha256 | no |
| alias | Defines the key alias to use if aliasMethod="STATIC" | String any character combination | none | no |
| aliasMethod | The method used to choose the keystore alias | AliasMethod One of the following values: default,selector,static,domain | default | no |
| canonicalization | Algorithm used to prepare the message data for signing | Canonicalization One of the following values: relaxed,simple | simple | no |
| domainList | A domain list of domains to sign with this filter | StringList Name of a StringList as defined in StringListService | none | no |
| domains | A comma separated list of domains to use this key signature with | String any character combination | none | no |
| headers | A 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 specification | String any character combination | The recommended list of headers to include as specified in section 5.5 of RFC 4871 | no |
| keyStore | The keystore containing the private key to sign the messages with | KeyStore Name of a KeyStore as defined in KeyStoreService | none | yes |
| queryMethod | The query method for the public key. Currently the only available query method is dns. | QueryMethod One of the following values: dns | dns | no |
| selector | Defines the selector name to use if selectorMethod="STATIC" | String any character combination | none | no |
| selectorMethod | The method used to choose the selector | SelectorMethod One of the following values: static | static | no |
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" />