$ npm install --save dkim
Object
Kind: global variable
DKIM : Object
String
String
String
String
String
String
Array.<String>
Kind: static class of DKIM
See: dkim-signature
DKIM Signature
Kind: static class of DKIM
See: dkim-key
DKIM Key
String
Kind: static property of DKIM
String
Kind: static property of DKIM
String
Kind: static property of DKIM
String
Kind: static property of DKIM
Retrieve a domain key
Kind: static method of DKIM
Todo
public_key = dkim_find_key(q_val, d_val, s_val)
,
where *_val
are the signature's attribute valuesParams
domain String
[selector] String
callback function
String
Canonicalize the message body according to methods defined in RFC[XXXX]
Kind: static method of DKIM
Throws:
Error
If canonicalization method is unsupportedParams
message Buffer
| String
method String
- (simple|relaxed)
String
Canonicalize the message header according to methods defined in RFC[6376]
Kind: static method of DKIM
Throws:
Error
If canonicalization method is unsupportedParams
Array.<String>
- Each header is formatted as <field>: <value>
Array
String
- (simple|relaxed)Example
DKIM.processHeader( [ 'A: X', 'B : Y\t\r\n\tZ '], [ 'A' ], 'relaxed' )
Verify a message signature
Kind: static method of DKIM
Params
body Buffer
headers Array
callback function
Verify a message's signatures
Kind: static method of DKIM
Throws:
Error
If input is not a bufferParams
message Buffer
callback function
Array.<String>
Filter out signature headers other than the specified signatureHeader
Kind: static method of verify
Returns: Array.<String>
- filtered headers
Params
headers Array.<String>
- list of headers to filter
signatureHeader String
- signature header to keep