SYNOPSIS |
#include <dkim.h>
DKIM_STAT dkim_policy(
DKIM *dkim,
bool *test,
bool *susp,
dkim_policy_t *pcode,
dkim_handling_t *hcode
);
Retrieve and evaluate the sender signing policy (SSP) for a message.
|
DESCRIPTION |
Called When |
dkim_policy() 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_verify().
|
test |
A pointer to boolean that is set to be either TRUE (if the policy
indicates the domain is using DKIM in a test mode), or FALSE otherwise.
|
susp |
A pointer to boolean that is set to be either TRUE (if the policy
indicates the message is suspicious), or FALSE otherwise.
|
pcode |
A pointer to a dkim_policy_t which is updated to contain
the policy type retrieved from the sender. This can be NULL if that
information is not of interest to the caller.
|
hcode |
A pointer to a dkim_handling_t which is updated to contain
the recommendation for handling suspicious messages as retrieved from
the sender. This can be NULL if that information is not of interest
to the caller.
|
|
NOTES |
- It is an error to call this function with a handle that was created
using dkim_sign().
- This function will return DKIM_STAT_SYNTAX if the sender's
domain could not be determined.
|