# dkim_policy_syntax()

[back to index]

SYNOPSIS

    #include <dkim.h>

    DKIM_STAT dkim_policy_syntax(
    	DKIM *dkim,
    	unsigned char *str,
    	size_t len
    );

Validates the syntax of a policy record, returning a result. The signature is not stored or used, only validated.

DESCRIPTION

Called When | `dkim_policy_syntax()` can be called at any time.

ARGUMENTS

Argument | Description
--- | ---
dkim | DKIM handle, returned by a prior call to `dkim_sign()` or `dkim_verify()`.
str | Pointer to a buffer containing the policy record to be evaluated.
len | Number of bytes available at `str`.

RETURN VALUES

Return Value | Description
--- | ---
DKIM_STAT_OK | The policy record appeared to be syntactically valid.
DKIM_STAT_SYNTAX | The policy record did not appear to be syntactically valid.

Copyright (c) 2008 Sendmail, Inc. and its suppliers. All rights reserved.
Copyright (c) 2009, 2010, The OpenDKIM Project. All rights reserved.
By using this file, you agree to the terms and conditions set forth in the respective licenses.