| Current File : //kunden/usr/share/doc/libopendmarc-devel/opendmarc_policy_parse_dmarc.html |
<html>
<head><title>opendmarc_policy_parse_dmarc()</title></head>
<body>
<!--
$Id: opendmarc_policy_parse_dmarc.html,v 1.5 2010/07/24 04:52:15 cm-msk Exp $
-->
<h1>opendmarc_policy_parse_dmarc()</h1>
<p align="right"><a href="index.html">[back to index]</a></p>
<table border="0" cellspacing=4 cellpadding=4>
<!---------- Synopsis ----------->
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
<pre>
#include <dmarc.h>
<a href="opendmarc_status_t.html"><tt>OPENDMARC_STATUS_T</tt></a> opendmarc_policy_parse_dmarc(
<a href="dmarc_policy_t.html"><tt>DMARC_POLICY_T</tt></a> *pctx,
u_char *domain, u_char *record
);
</pre>
Provide the library with a DMARC record to parse.
</td></tr>
<!----------- Description ---------->
<tr><th valign="top" align=left>DESCRIPTION</th><td>
<table border="1" cellspacing=1 cellpadding=4>
<tr align="left" valign=top>
<th width="80">Called When</th>
<td><tt>opendmarc_policy_parse_dmarc()</tt>
must be called before you call <a href="opendmarc_get_policy_to_enforce.html">opendmarc_get_policy_to_enforce()</a>.
</tr>
</table>
<!----------- Arguments ---------->
<tr><th valign="top" align=left>ARGUMENTS</th><td>
<table border="1" cellspacing=0>
<tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
<tr valign="top"><td>pctx</td>
<td>The address of a structure of type <a href="dmarc_policy_t.html">
<tt>DMARC_POLICY_T</tt></a> as returned from <a href="opendmarc_policy_connect_init.html">opendmarc_policy_connect_init()</a>.
</td></tr>
<tr valign="top"><td>domain</td>
<td>A string containing the domain for which you looked up the <tt>DMARC</tt> record.
</td></tr>
<tr valign="top"><td>record</td>
<td>A string containing the <tt>DMARC</tt> record that the library should parse.
</td></tr>
</table>
</td></tr>
<!----------- Return Values ---------->
<tr>
<th valign="top" align=left>RETURN VALUES</th>
<td>
<ul>
<li><tt>DMARC_PARSE_OKAY</tt> -- Success.
<li><tt>DMARC_PARSE_ERROR_NULL_CTX</tt> -- If you passed in a <tt>pctx</tt> value that was NULL.
<li><tt>DMARC_PARSE_ERROR_BAD_VERSION</tt> -- If the <tt>DMARC</tt> record's <tt>v=</tt> was bad.
<li><tt>DMARC_PARSE_ERROR_BAD_VALUE</tt> -- If a value following an <tt>=</tt> was bad or illegal.
<li><tt>DMARC_PARSE_ERROR_NO_REQUIRED_P</tt> -- The required <tt>p=</tt> was absent.
</ul>
</td>
</tr>
<!----------- Notes ---------->
<tr>
<th valign="top" align=left>NOTES</th>
<td>
<ul>
<li>In general, avoid calling this function directly. Instead call
<a href="opendmarc_policy_store_dmarc.html">opendmarc_policy_store_dmarc()</a> instead.
<li>This function expects the <tt>DMARC</tt> record to be supplied as a single line of text. If the record appeared
in <tt>DNS</tt> as a collection of quoted parts, you must assemble those parts into a single string before calling this
function.
</ul>
</td>
</tr>
</table>
<hr size="1">
<font size="-1">
Copyright (c) 2012, The Trusted Domain Project. All rights reserved.
<br>
By using this file, you agree to the terms and conditions set
forth in the license.
</font>
</body>
</html>