filter
DKIM Signature Filter — Signs emails using DKIM, and adds a DKIM-Signature header to emails<filter/>
| Name: | filter |
| Required by Parent Tag: | No |
| Multiple Tag Instances supported: | Yes |
Table 30. Attributes for filter tag (for xms.filter.dkim.DKIMSignatureFilter)
| Name | Friendly Name | Description | Type | Default Value | Required |
|---|---|---|---|---|---|
| class | Class | The class name the service manager loads. To load: DKIM Signature Filter use: class xms.filter.dkim.DKIMSignatureFilter | Class Name A fully qualified class name for a class that is part of the java classpath. | xms.filter.dkim.DKIMSignatureFilter | Yes |
| keystore | Key Store | The name of the keystore containing the private key to sign the messages with | String Any character combination is valid. | none | Yes |
| selector | Selector | Defines the selector name to use if selectorMethod="STATIC" | String Any character combination is valid. | none | Yes |
| domainlist | Domain List | A domain list of domains to sign with this filter. | String Any character combination is valid. | none | No |
| domains | Domains | A comma separated list of domains to use this key signature with. | String Any character combination is valid. | none | No |
| canonicalization | Canonicalization Algorithm | Algorithm used to encode the message. | Finite Value Set Value Must be one of the following: [relaxed, simple] | relaxed | No |
| alias | Alias | Defines the key alias to use if aliasMethod="STATIC" | String Any character combination is valid. | none | No |
| aliasmethod | Alias Method | The method used to choose the keystore alias. | Finite Value Set Value must be one of [selector, domain, default, static] | DEFAULT | No |
| selectormethod | Selector Method | The method used to choose the selector. | Finite Value Set Value must be one of [static] | STATIC | No |
| querymethod | Query Method | The query method for the public key. The only method in the rfc as of this writing is dns. | String Any character combination is valid. | dns | No |
| algorithm | Signature Algorithm | The algorithm used to generate the domain key signature. | Finite Value Set Value Must be one of the following: [rsa-sha256, rsa-sha1] | rsa-sha256 | No |
| headers | 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 is valid. | From,Sender,Reply-To,Subject,Date,Message-ID,To,Cc,Mime-Version,Content-Type,Content-Transfer-Encoding,Content-ID,Content-Description,Resent-Date,Resent-From,Resent-Sender,Resent-To,Resent-cc,Resent-Message-ID,In-Reply-To,ReferencesList-Id,List-Help,List-Unsubscribe,List-Subscribe,List-Post,List-Owner,List-Archive | No |
This tag depends on the following services (or a service that extends or implements these classes)
Example 25. Example configuration for DKIM Signature Filter
Required attributes are marked with a bold typeface
<filter class="xms.filter.dkim.DKIMSignatureFilter" keystore="keystore" selector="selector" domainlist="domainlist" domains="domains" canonicalization="relaxed" alias="alias" aliasmethod="DEFAULT" selectormethod="STATIC" querymethod="dns" algorithm="rsa-sha256" headers="From,Sender,Reply-To,Subject,Date,Message-ID,To,Cc,Mime-Version,Content-Type,Content-Transfer-Encoding,Content-ID,Content-Description,Resent-Date,Resent-From,Resent-Sender,Resent-To,Resent-cc,Resent-Message-ID,In-Reply-To,ReferencesList-Id,List-Help,List-Unsubscribe,List-Subscribe,List-Post,List-Owner,List-Archive" />