msys.validate.opendkim.get_sig_hdrsigned
Name
msys.validate.opendkim.get_sig_hdrsigned — Determine whether a given header was signed
Synopsis
msys.validate.opendkim.get_sig_hdrsigned(dkim_sig, header_name)
dkim_sig: userdata, DKIM_SIGINFO type header_name: string
Description
This function determines whether a header has been signed. Use msys.validate.opendkim.get_num_sigs
and msys.validate.opendkim.get_sig
to get a DKIM_SIGINFO object to pass to this function. For a description of the DKIM_SIGINFO object, see DKIM_DSIGINFO.
This function requires the opendkim
module.
Enable this function with the statement require('msys.validate.opendkim');
.
This function returns a Boolean indicating whether the specified header has been signed and the DKIM status DKIM_STAT
.
The DKIM status DKIM_STAT
can be one of the following values:
-
DKIM_STAT_OK
– successful completion -
DKIM_STAT_BADSIG
– signature did not match headers and body -
DKIM_STAT_NOSIG
– no signature present -
DKIM_STAT_NOKEY
– no key available for verifying -
DKIM_STAT_CANTVRFY
– cannot get key for verifying -
DKIM_STAT_SYNTAX
– message is not in valid syntax -
DKIM_STAT_NORESOURCE
– resource unavailable -
DKIM_STAT_INTERNAL
– internal error -
DKIM_STAT_REVOKED
– signing key revoked -
DKIM_STAT_INVALID
– invalid parameter(s) -
DKIM_STAT_NOTIMPLEMENT
– function not implemented -
DKIM_STAT_KEYFAIL
– key retrieval failed (try again later) -
DKIM_STAT_CBREJECT
– callback requested message rejection -
DKIM_STAT_CBTRYAGAIN
– callback cannot complete (try again later) -
DKIM_STAT_CBERROR
– unspecified callback error
See Also
msys.validate.opendkim.get_sig_canons, msys.validate.opendkim.sign, msys.validate.opendkim.verify, msys.validate.opendkim.get_num_sigs, msys.validate.opendkim.get_sig, msys.validate.opendkim.get_sig_domain, msys.validate.opendkim.get_sig_selector, msys.validate.opendkim.get_sig_errorstr, msys.validate.opendkim.get_sig_flags, msys.validate.opendkim.get_sig_identity, msys.validate.opendkim.get_sig_keysize, msys.validate.opendkim.get_sig_signalg