Skip to main content

msys.validate.opendkim.get_sig_hdrsigned

Last updated March 2020

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

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

This function requires the opendkim module. 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 returns a Boolean indicating whether the specified header has been signed. It also returns the DKIM status (DKIM_STAT) which 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');.

See Also

Was this page helpful?