smfi_getsymval.html revision 112810
190792Sgshapiro<html> 290792Sgshapiro<head><title>smfi_getsymval</title></head> 390792Sgshapiro<body> 490792Sgshapiro<h1>smfi_getsymval</h1> 590792Sgshapiro 690792Sgshapiro<table border="0" cellspacing=4 cellpadding=4> 790792Sgshapiro<!---------- Synopsis -----------> 890792Sgshapiro<tr><th valign="top" align=left width=150>SYNOPSIS</th><td> 990792Sgshapiro<pre> 1090792Sgshapiro#include <libmilter/mfapi.h> 1190792Sgshapirochar* smfi_getsymval( 1290792Sgshapiro SMFICTX *ctx, 1390792Sgshapiro char *symname 1490792Sgshapiro); 1590792Sgshapiro</pre> 1690792SgshapiroGet the value of a sendmail macro. 1790792Sgshapiro</td></tr> 1890792Sgshapiro 1990792Sgshapiro<!----------- Description ----------> 2090792Sgshapiro<tr><th valign="top" align=left>DESCRIPTION</th><td> 2190792Sgshapiro<table border="1" cellspacing=1 cellpadding=4> 2290792Sgshapiro<tr align="left" valign=top> 2390792Sgshapiro<th width="80">Called When</th> 2490792Sgshapiro<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> 2590792Sgshapiro</tr> 2690792Sgshapiro<tr align="left" valign=top> 2790792Sgshapiro<th width="80">Effects</th> 2890792Sgshapiro<td>None.</td> 2990792Sgshapiro</tr> 3090792Sgshapiro</table> 3190792Sgshapiro 3290792Sgshapiro<!----------- Arguments ----------> 3390792Sgshapiro<tr><th valign="top" align=left>ARGUMENTS</th><td> 3490792Sgshapiro <table border="1" cellspacing=0> 3590792Sgshapiro <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr> 3690792Sgshapiro <tr valign="top"><td>ctx</td> 3790792Sgshapiro <td>The opaque context structure. 3890792Sgshapiro </td></tr> 3990792Sgshapiro <tr valign="top"><td>symname</td> 4098841Sgshapiro <td>The name of a sendmail macro. 4198841Sgshapiro Single letter macros can optionally be enclosed in braces ("{" and "}"), 4298841Sgshapiro longer macro names must be enclosed in braces, just as in a 4398841Sgshapiro <tt>sendmail.cf</tt> file. 4498841Sgshapiro <a href="#notes">See below</a> for default macros. 4590792Sgshapiro </td></tr> 4690792Sgshapiro </table> 4790792Sgshapiro</td></tr> 4890792Sgshapiro 4990792Sgshapiro<!----------- Return values ----------> 5090792Sgshapiro<tr> 5190792Sgshapiro<th valign="top" align=left>RETURN VALUES</th> 5290792Sgshapiro 5390792Sgshapiro<td>smfi_getsymval returns the value of the given macro as a null-terminated string, or NULL if the macro is not defined.</td> 5490792Sgshapiro</tr> 5590792Sgshapiro 5690792Sgshapiro<!----------- Notes ----------> 5790792Sgshapiro<tr align="left" valign=top> 5890792Sgshapiro<th><a name="notes">NOTES</A></th> 5990792Sgshapiro<td> 6090792SgshapiroBy default, the following macros are valid in the given contexts: 6190792Sgshapiro 6290792Sgshapiro<table border="1" cellspacing=0> 6390792Sgshapiro<tr bgcolor="#dddddd"><th>Sent With</th><th>Macros</th></tr> 6490792Sgshapiro<tr><td>xxfi_connect</td> <td>daemon_name, if_name, if_addr, j, _</td></tr> 6590792Sgshapiro<tr><td>xxfi_helo</td> <td>tls_version, cipher, cipher_bits, cert_subject, cert_issuer</td></tr> 6690792Sgshapiro<tr><td>xxfi_envfrom</td> <td>i, auth_type, auth_authen, auth_ssf, auth_author, 6790792Sgshapiro mail_mailer, mail_host, mail_addr</td></tr> 6890792Sgshapiro<tr><td>xxfi_envrcpt</td> <td>rcpt_mailer, rcpt_host, rcpt_addr</td></tr> 6990792Sgshapiro</table> 7090792Sgshapiro<p> 7190792SgshapiroAll macros stay in effect from the point they are received until the 7290792Sgshapiroend of the connection for the first two sets, the end of the message 7390792Sgshapirofor the third (xxfi_envfrom), and just for each recipient for the 7490792Sgshapirofinal set (xxfi_envrcpt). 7590792Sgshapiro<p> 7690792SgshapiroThe macro list can be changed using the confMILTER_MACROS_* options in 7790792Sgshapirosendmail.mc. The scopes of such macros will be determined by when 7890792Sgshapirothey are set by sendmail. For descriptions of macros' values, please 7990792Sgshapirosee the "Sendmail Installation and Operation Guide" provided with your 8090792Sgshapirosendmail distribution. 8190792Sgshapiro 8290792Sgshapiro</td> 8390792Sgshapiro</tr> 8490792Sgshapiro 8590792Sgshapiro</table> 8690792Sgshapiro 8790792Sgshapiro<hr size="1"> 8890792Sgshapiro<font size="-1"> 89112810SgshapiroCopyright (c) 2000, 2002-2003 Sendmail, Inc. and its suppliers. 9090792SgshapiroAll rights reserved. 9190792Sgshapiro<br> 9290792SgshapiroBy using this file, you agree to the terms and conditions set 93112810Sgshapiroforth in the LICENSE. 9490792Sgshapiro</font> 9590792Sgshapiro</body> 9690792Sgshapiro</html> 97