~ubuntu-branches/ubuntu/quantal/opendmarc/quantal-backports

« back to all changes in this revision

Viewing changes to libopendmarc/docs/opendmarc_policy_store_from_domain.html

  • Committer: Package Import Robot
  • Author(s): Scott Kitterman
  • Date: 2013-04-01 23:20:45 UTC
  • mfrom: (4.1.3 sid)
  • Revision ID: package-import@ubuntu.com-20130401232045-r994v0oz6b2ha6ef
Tags: 1.1.2-1~ubuntu12.10.1
No-change backport to quantal

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<html>
 
2
<head><title>opendmarc_policy_store_from_domain()</title></head>
 
3
<body>
 
4
<!--
 
5
$Id: opendmarc_policy_store_from_domain.html,v 1.5 2010/07/24 04:52:15 cm-msk Exp $
 
6
-->
 
7
<h1>opendmarc_policy_store_from_domain()</h1>
 
8
<p align="right"><a href="index.html">[back to index]</a></p>
 
9
 
 
10
<table border="0" cellspacing=4 cellpadding=4>
 
11
<!---------- Synopsis ----------->
 
12
<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
 
13
<pre>
 
14
#include &lt;dmarc.h&gt;
 
15
<a href="dmarc_policy_t.html"><tt>DMARC_POLICY_T</tt></a> * opendmarc_policy_store_from_domain(
 
16
        <a href="dmarc_policy_t.html"><tt>DMARC_POLICY_T</tt></a> * pctx,
 
17
        u_char *from_domain
 
18
);
 
19
</pre>
 
20
As soon as possible after you have located the first From: header, you should pass the value of that header to this
 
21
function. 
 
22
</td></tr>
 
23
 
 
24
<!----------- Description ---------->
 
25
<tr><th valign="top" align=left>DESCRIPTION</th><td>
 
26
<table border="1" cellspacing=1 cellpadding=4>
 
27
<tr align="left" valign=top>
 
28
<th width="80">Called When</th>
 
29
<td><tt>opendmarc_policy_store_from_domain()</tt>
 
30
        may be called while processing headers or after all headers have been processed.
 
31
</tr>
 
32
</table>
 
33
 
 
34
<!----------- Arguments ---------->
 
35
<tr><th valign="top" align=left>ARGUMENTS</th><td>
 
36
    <table border="1" cellspacing=0>
 
37
    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
 
38
    <tr valign="top"><td>pctx</td>
 
39
        <td>A pointer to type <a href="dmarc_policy_t.html"><tt>DMARC_POLICY_T</tt></a>.
 
40
        </td></tr>
 
41
    <tr valign="top"><td>from_domain</td>
 
42
        <td>A pointer to a string containing unsigned characters.
 
43
        </td></tr>
 
44
    </table>
 
45
</td></tr>
 
46
 
 
47
<!----------- Return Values ---------->
 
48
<tr>
 
49
<th valign="top" align=left>RETURN VALUES</th> 
 
50
<td>
 
51
<ul>
 
52
<li><tt>DMARC_PARSE_OKAY</tt> -- On success
 
53
<li><tt>DMARC_PARSE_ERROR_NULL_CTX</tt> -- If pctx was NULL
 
54
<li><tt>DMARC_PARSE_ERROR_EMPTY</tt> -- If from_domain was NULL or zero length
 
55
<li><tt>DMARC_PARSE_ERROR_NO_DOMAIN</tt> -- If from_domain did not contain a domain, e.g. "&lt;&gt;"
 
56
</ul>
 
57
</td>
 
58
</tr>
 
59
 
 
60
<!----------- Notes ---------->
 
61
<tr>
 
62
<th valign="top" align=left>NOTES</th> 
 
63
<td>
 
64
<ul>
 
65
<li>You may pass the whole From: header to this function, or the value of the From: header or just the domain
 
66
you parsed from that address. This function will correctly handle whatever you feed it.
 
67
</ul>
 
68
</td>
 
69
</tr>
 
70
</table>
 
71
 
 
72
<hr size="1">
 
73
<font size="-1">
 
74
Copyright (c) 2012, The Trusted Domain Project.  All rights reserved.
 
75
 
 
76
<br>
 
77
By using this file, you agree to the terms and conditions set
 
78
forth in the license.
 
79
</font>
 
80
</body>
 
81
</html>