smfi_getsymval.html revision 90792 
175584Sru<html>
275584Sru<head><title>smfi_getsymval</title></head>
375584Sru<body>
4104862Sru<h1>smfi_getsymval</h1>
575584Sru
675584Sru<table border="0" cellspacing=4 cellpadding=4>
775584Sru<!---------- Synopsis ----------->
875584Sru<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
975584Sru<pre>
1075584Sru#include &lt;libmilter/mfapi.h&gt;
1175584Sruchar* smfi_getsymval(
1275584Sru	SMFICTX *ctx,
1375584Sru	char *symname
1475584Sru);
15104862Sru</pre>
1675584SruGet the value of a sendmail macro.
1775584Sru</td></tr>
1875584Sru
1975584Sru<!----------- Description ---------->
2075584Sru<tr><th valign="top" align=left>DESCRIPTION</th><td>
2175584Sru<table border="1" cellspacing=1 cellpadding=4>
22104862Sru<tr align="left" valign=top>
2375584Sru<th width="80">Called When</th>
2475584Sru<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>
2575584Sru</tr>
2675584Sru<tr align="left" valign=top>
2775584Sru<th width="80">Effects</th>
2875584Sru<td>None.</td>
2975584Sru</tr>
3075584Sru</table>
3175584Sru
3275584Sru<!----------- Arguments ---------->
3375584Sru<tr><th valign="top" align=left>ARGUMENTS</th><td>
3475584Sru    <table border="1" cellspacing=0>
3575584Sru    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
3675584Sru    <tr valign="top"><td>ctx</td>
3775584Sru	<td>The opaque context structure.
3875584Sru	</td></tr>
3975584Sru    <tr valign="top"><td>symname</td>
4075584Sru	<td>The name of a sendmail macro, optinally enclosed in braces ("{" and "}").  <a href="#notes">See below</a> for default macros.
4175584Sru	</td></tr>
4275584Sru    </table>
4375584Sru</td></tr>
4475584Sru
4575584Sru<!----------- Return values ---------->
4675584Sru<tr>
4775584Sru<th valign="top" align=left>RETURN VALUES</th> 
4875584Sru
4975584Sru<td>smfi_getsymval returns the value of the given macro as a null-terminated string, or NULL if the macro is not defined.</td>
5075584Sru</tr>
5175584Sru
5275584Sru<!----------- Notes ---------->
5375584Sru<tr align="left" valign=top>
5475584Sru<th><a name="notes">NOTES</A></th> 
5575584Sru<td>
5675584SruBy default, the following macros are valid in the given contexts:
5775584Sru
5875584Sru<table border="1" cellspacing=0>
5975584Sru<tr bgcolor="#dddddd"><th>Sent With</th><th>Macros</th></tr>
6075584Sru<tr><td>xxfi_connect</td>    <td>daemon_name, if_name, if_addr, j, _</td></tr>
6175584Sru<tr><td>xxfi_helo</td>       <td>tls_version, cipher, cipher_bits, cert_subject, cert_issuer</td></tr>
6275584Sru<tr><td>xxfi_envfrom</td>    <td>i, auth_type, auth_authen, auth_ssf, auth_author,
6375584Sru                mail_mailer, mail_host, mail_addr</td></tr>
6475584Sru<tr><td>xxfi_envrcpt</td>    <td>rcpt_mailer, rcpt_host, rcpt_addr</td></tr>
6575584Sru</table>
6675584Sru<p>
6775584SruAll macros stay in effect from the point they are received until the
6875584Sruend of the connection for the first two sets, the end of the message
6975584Srufor the third (xxfi_envfrom), and just for each recipient for the
7075584Srufinal set (xxfi_envrcpt).
7175584Sru<p>
7275584SruThe macro list can be changed using the confMILTER_MACROS_* options in
7375584Srusendmail.mc.  The scopes of such macros will be determined by when
7475584Sruthey are set by sendmail.  For descriptions of macros' values, please
7575584Srusee the "Sendmail Installation and Operation Guide" provided with your
7675584Srusendmail distribution.
7775584Sru
7875584Sru</td>
7975584Sru</tr>
8075584Sru
8175584Sru</table>
8275584Sru
8375584Sru<hr size="1">
8475584Sru<font size="-1">
8575584SruCopyright (c) 2000 Sendmail, Inc. and its suppliers.
8675584SruAll rights reserved.
8775584Sru<br>
8875584SruBy using this file, you agree to the terms and conditions set
8975584Sruforth in the <a href="LICENSE.txt">LICENSE</a>.
9075584Sru</font>
9175584Sru</body>
9275584Sru</html>
9375584Sru