msys.validate.opendkim.get_sig_flags

msys.validate.opendkim.get_sig_flags — Fetch the flags associated with a DKIM signature

msys.validate.opendkim.get_sig_flags(dkim_sig)

dkim_sig: userdata, DKIM_SIGINFO type

**Configuration Change. ** This function is available as of version 3.6.

This function requires the opendkim module. This function fetches the flags associated with a DKIM signature. 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.

Note that the return value is a flags bitmap. The following values are applicable:

• DKIM_SIGFLAG_IGNORE – The signature has been flagged to be ignored.

• DKIM_SIGFLAG_PROCESSED – The signature has had DNS validation attempted.

• DKIM_SIGFLAG_PASSED – DNS validation succeeded.

• DKIM_SIGFLAG_TESTKEY – Keys "in test" flag was set.

• DKIM_SIGFLAG_NOSUBDOMAIN – Keys "not for use with subdomains" flag was set.

These values are found in the opendkim.dkim namespace. For more information about the flags bitmap see dkim_sig_getflags.

The DKIM status (DKIM_STAT) can be any 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 – can't 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 can't complete (try again later)

• DKIM_STAT_CBERROR – unspecified callback error

Enable this function with the statement require('msys.validate.opendkim');.

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_identity, msys.validate.opendkim.get_sig_keysize, msys.validate.opendkim.get_sig_signalg, msys.validate.opendkim.get_sig_hdrsigned, msys.validate.opendkim.get_sig_canons, “opendkim – OpenDKIM module” and “dkim – DomainKeys Identified Mail Signatures”