xref: /freebsd/contrib/sendmail/libmilter/docs/smfi_getsymval.html (revision 4026605903c0ab8df33c4ae8c419acdb2b652af8)
140266059SGregory Neil Shapiro<html>
240266059SGregory Neil Shapiro<head><title>smfi_getsymval</title></head>
340266059SGregory Neil Shapiro<body>
440266059SGregory Neil Shapiro<h1>smfi_getsymval</h1>
540266059SGregory Neil Shapiro
640266059SGregory Neil Shapiro<table border="0" cellspacing=4 cellpadding=4>
740266059SGregory Neil Shapiro<!---------- Synopsis ----------->
840266059SGregory Neil Shapiro<tr><th valign="top" align=left width=150>SYNOPSIS</th><td>
940266059SGregory Neil Shapiro<pre>
1040266059SGregory Neil Shapiro#include &lt;libmilter/mfapi.h&gt;
1140266059SGregory Neil Shapirochar* smfi_getsymval(
1240266059SGregory Neil Shapiro	SMFICTX *ctx,
1340266059SGregory Neil Shapiro	char *symname
1440266059SGregory Neil Shapiro);
1540266059SGregory Neil Shapiro</pre>
1640266059SGregory Neil ShapiroGet the value of a sendmail macro.
1740266059SGregory Neil Shapiro</td></tr>
1840266059SGregory Neil Shapiro
1940266059SGregory Neil Shapiro<!----------- Description ---------->
2040266059SGregory Neil Shapiro<tr><th valign="top" align=left>DESCRIPTION</th><td>
2140266059SGregory Neil Shapiro<table border="1" cellspacing=1 cellpadding=4>
2240266059SGregory Neil Shapiro<tr align="left" valign=top>
2340266059SGregory Neil Shapiro<th width="80">Called When</th>
2440266059SGregory Neil Shapiro<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>
2540266059SGregory Neil Shapiro</tr>
2640266059SGregory Neil Shapiro<tr align="left" valign=top>
2740266059SGregory Neil Shapiro<th width="80">Effects</th>
2840266059SGregory Neil Shapiro<td>None.</td>
2940266059SGregory Neil Shapiro</tr>
3040266059SGregory Neil Shapiro</table>
3140266059SGregory Neil Shapiro
3240266059SGregory Neil Shapiro<!----------- Arguments ---------->
3340266059SGregory Neil Shapiro<tr><th valign="top" align=left>ARGUMENTS</th><td>
3440266059SGregory Neil Shapiro    <table border="1" cellspacing=0>
3540266059SGregory Neil Shapiro    <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr>
3640266059SGregory Neil Shapiro    <tr valign="top"><td>ctx</td>
3740266059SGregory Neil Shapiro	<td>The opaque context structure.
3840266059SGregory Neil Shapiro	</td></tr>
3940266059SGregory Neil Shapiro    <tr valign="top"><td>symname</td>
4040266059SGregory Neil Shapiro	<td>The name of a sendmail macro, optinally enclosed in braces ("{" and "}").  <a href="#notes">See below</a> for default macros.
4140266059SGregory Neil Shapiro	</td></tr>
4240266059SGregory Neil Shapiro    </table>
4340266059SGregory Neil Shapiro</td></tr>
4440266059SGregory Neil Shapiro
4540266059SGregory Neil Shapiro<!----------- Return values ---------->
4640266059SGregory Neil Shapiro<tr>
4740266059SGregory Neil Shapiro<th valign="top" align=left>RETURN VALUES</th>
4840266059SGregory Neil Shapiro
4940266059SGregory Neil Shapiro<td>smfi_getsymval returns the value of the given macro as a null-terminated string, or NULL if the macro is not defined.</td>
5040266059SGregory Neil Shapiro</tr>
5140266059SGregory Neil Shapiro
5240266059SGregory Neil Shapiro<!----------- Notes ---------->
5340266059SGregory Neil Shapiro<tr align="left" valign=top>
5440266059SGregory Neil Shapiro<th><a name="notes">NOTES</A></th>
5540266059SGregory Neil Shapiro<td>
5640266059SGregory Neil ShapiroBy default, the following macros are valid in the given contexts:
5740266059SGregory Neil Shapiro
5840266059SGregory Neil Shapiro<table border="1" cellspacing=0>
5940266059SGregory Neil Shapiro<tr bgcolor="#dddddd"><th>Sent With</th><th>Macros</th></tr>
6040266059SGregory Neil Shapiro<tr><td>xxfi_connect</td>    <td>daemon_name, if_name, if_addr, j, _</td></tr>
6140266059SGregory Neil Shapiro<tr><td>xxfi_helo</td>       <td>tls_version, cipher, cipher_bits, cert_subject, cert_issuer</td></tr>
6240266059SGregory Neil Shapiro<tr><td>xxfi_envfrom</td>    <td>i, auth_type, auth_authen, auth_ssf, auth_author,
6340266059SGregory Neil Shapiro                mail_mailer, mail_host, mail_addr</td></tr>
6440266059SGregory Neil Shapiro<tr><td>xxfi_envrcpt</td>    <td>rcpt_mailer, rcpt_host, rcpt_addr</td></tr>
6540266059SGregory Neil Shapiro</table>
6640266059SGregory Neil Shapiro<p>
6740266059SGregory Neil ShapiroAll macros stay in effect from the point they are received until the
6840266059SGregory Neil Shapiroend of the connection for the first two sets, the end of the message
6940266059SGregory Neil Shapirofor the third (xxfi_envfrom), and just for each recipient for the
7040266059SGregory Neil Shapirofinal set (xxfi_envrcpt).
7140266059SGregory Neil Shapiro<p>
7240266059SGregory Neil ShapiroThe macro list can be changed using the confMILTER_MACROS_* options in
7340266059SGregory Neil Shapirosendmail.mc.  The scopes of such macros will be determined by when
7440266059SGregory Neil Shapirothey are set by sendmail.  For descriptions of macros' values, please
7540266059SGregory Neil Shapirosee the "Sendmail Installation and Operation Guide" provided with your
7640266059SGregory Neil Shapirosendmail distribution.
7740266059SGregory Neil Shapiro
7840266059SGregory Neil Shapiro</td>
7940266059SGregory Neil Shapiro</tr>
8040266059SGregory Neil Shapiro
8140266059SGregory Neil Shapiro</table>
8240266059SGregory Neil Shapiro
8340266059SGregory Neil Shapiro<hr size="1">
8440266059SGregory Neil Shapiro<font size="-1">
8540266059SGregory Neil ShapiroCopyright (c) 2000 Sendmail, Inc. and its suppliers.
8640266059SGregory Neil ShapiroAll rights reserved.
8740266059SGregory Neil Shapiro<br>
8840266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set
8940266059SGregory Neil Shapiroforth in the <a href="LICENSE.txt">LICENSE</a>.
9040266059SGregory Neil Shapiro</font>
9140266059SGregory Neil Shapiro</body>
9240266059SGregory Neil Shapiro</html>
93