Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional cacheDir

cacheDir: string | false

optional location for cached messages. If not set then caching is not used.

Optional cacheTreshold

cacheTreshold: undefined | number

optional size in bytes, if message is larger than this treshold it gets cached to disk (assuming cacheDir is set and writable). Defaults to 131072 (128 kB).

domainName

domainName: string

is the domain name to use in the signature

Optional hashAlgo

hashAlgo: undefined | string

optional algorithm for the body hash, defaults to ‘sha256’

Optional headerFieldNames

headerFieldNames: undefined | string

an optional colon separated list of header keys to sign (eg. message-id:date:from:to...')

keySelector

keySelector: string

is the DKIM key selector

privateKey

privateKey: string | object

is the private key for the selector in PEM format

Optional skipFields

skipFields: undefined | string

optional colon separated list of header keys not to sign. This is useful if you want to sign all the relevant keys but your provider changes some values, ie Message-ID and Date. In this case you should use 'message-id:date' to prevent signing these values.

Generated using TypeDoc