smfi_getsymval.html revision 90792 
1<html>
2<head><title>smfi_getsymval</title></head>
3<body>
4<h1>smfi_getsymval</h1>
5
6<table border="0" cellspacing=4 cellpadding=4>
7<!---------- Synopsis ----------->
8<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
9<pre>
10#include &lt;libmilter/mfapi.h&gt;
11char* smfi_getsymval(
12	SMFICTX *ctx,
13	char *symname
14);
15</pre>
16Get the value of a sendmail macro.
17</td></tr>
18
19<!----------- Description ---------->
20<tr><th valign="top" align=left>DESCRIPTION</th><td>
21<table border="1" cellspacing=1 cellpadding=4>
22<tr align="left" valign=top>
23<th width="80">Called When</th>
24<td>smfi_getsymval may be called from within any of the xxfi_* callbacks.  Which macros are defined will depend on when it is called.</td>
25</tr>
26<tr align="left" valign=top>
27<th width="80">Effects</th>
28<td>None.</td>
29</tr>
30</table>
31
32<!----------- Arguments ---------->
33<tr><th valign="top" align=left>ARGUMENTS</th><td>
34    <table border="1" cellspacing=0>
35    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
36    <tr valign="top"><td>ctx</td>
37	<td>The opaque context structure.
38	</td></tr>
39    <tr valign="top"><td>symname</td>
40	<td>The name of a sendmail macro, optinally enclosed in braces ("{" and "}").  <a href="#notes">See below</a> for default macros.
41	</td></tr>
42    </table>
43</td></tr>
44
45<!----------- Return values ---------->
46<tr>
47<th valign="top" align=left>RETURN VALUES</th> 
48
49<td>smfi_getsymval returns the value of the given macro as a null-terminated string, or NULL if the macro is not defined.</td>
50</tr>
51
52<!----------- Notes ---------->
53<tr align="left" valign=top>
54<th><a name="notes">NOTES</A></th> 
55<td>
56By default, the following macros are valid in the given contexts:
57
58<table border="1" cellspacing=0>
59<tr bgcolor="#dddddd"><th>Sent With</th><th>Macros</th></tr>
60<tr><td>xxfi_connect</td>    <td>daemon_name, if_name, if_addr, j, _</td></tr>
61<tr><td>xxfi_helo</td>       <td>tls_version, cipher, cipher_bits, cert_subject, cert_issuer</td></tr>
62<tr><td>xxfi_envfrom</td>    <td>i, auth_type, auth_authen, auth_ssf, auth_author,
63                mail_mailer, mail_host, mail_addr</td></tr>
64<tr><td>xxfi_envrcpt</td>    <td>rcpt_mailer, rcpt_host, rcpt_addr</td></tr>
65</table>
66<p>
67All macros stay in effect from the point they are received until the
68end of the connection for the first two sets, the end of the message
69for the third (xxfi_envfrom), and just for each recipient for the
70final set (xxfi_envrcpt).
71<p>
72The macro list can be changed using the confMILTER_MACROS_* options in
73sendmail.mc.  The scopes of such macros will be determined by when
74they are set by sendmail.  For descriptions of macros' values, please
75see the "Sendmail Installation and Operation Guide" provided with your
76sendmail distribution.
77
78</td>
79</tr>
80
81</table>
82
83<hr size="1">
84<font size="-1">
85Copyright (c) 2000 Sendmail, Inc. and its suppliers.
86All rights reserved.
87<br>
88By using this file, you agree to the terms and conditions set
89forth in the <a href="LICENSE.txt">LICENSE</a>.
90</font>
91</body>
92</html>
93