dkim_reportinfo()

SYNOPSIS

#include <dkim.h>
DKIM_STAT dkim_reportinfo(
	DKIM *dkim,
        int *fd,
        int *bfd,
        char *buf,
        size_t len
);

Retrieve information required to generate a failure report. The calling application can use this information to generate a DSN-like report for use in determining the cause of interoperability problems between implementations.

DESCRIPTION

Called When	`dkim_reportinfo()` is called after `dkim_eom()` when `dkim` is a verifying handle, i.e. one returned by an earlier call to `dkim_verify()`.

ARGUMENTS

Argument	Description
dkim	Message-specific handle, returned by `dkim_sign()` or `dkim_verify`.
fd	A pointer to an integer which will be updated to contain a file descriptor referencing a file which contains the canonicalized version of the message headers which failed to verify. Can be NULL if this information is not needed by the caller.
bfd	A pointer to an integer which will be updated to contain a file descriptor referencing a file which contains the canonicalized version of the message body which failed to verify. Can be NULL if this information is not needed by the caller.
buf	A buffer into which the destination address of the report, as extracted from the domain's policy record, will be written. Can be NULL if this information is not needed by the caller.
len	Number of bytes available at `buf`.

NOTES

This function is a local addition to the formal API specification and is experimental only. It may not appear in other implementations.