1d0cef73dSGregory Neil Shapiro<HTML> 2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>smfi_getsymval</TITLE></HEAD> 3d0cef73dSGregory Neil Shapiro<BODY> 4e92d3f3fSGregory Neil Shapiro<!-- 54313cc83SGregory Neil Shapiro$Id: smfi_getsymval.html,v 1.16 2013-11-22 20:51:39 ca Exp $ 6e92d3f3fSGregory Neil Shapiro--> 7d0cef73dSGregory Neil Shapiro<H1>smfi_getsymval</H1> 840266059SGregory Neil Shapiro 9d0cef73dSGregory Neil Shapiro<TABLE border="0" cellspacing=4 cellpadding=4> 1040266059SGregory Neil Shapiro<!---------- Synopsis -----------> 11d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD> 12d0cef73dSGregory Neil Shapiro<PRE> 1340266059SGregory Neil Shapiro#include <libmilter/mfapi.h> 1440266059SGregory Neil Shapirochar* smfi_getsymval( 1540266059SGregory Neil Shapiro SMFICTX *ctx, 1640266059SGregory Neil Shapiro char *symname 1740266059SGregory Neil Shapiro); 18d0cef73dSGregory Neil Shapiro</PRE> 1940266059SGregory Neil ShapiroGet the value of a sendmail macro. 20d0cef73dSGregory Neil Shapiro</TD></TR> 2140266059SGregory Neil Shapiro 2240266059SGregory Neil Shapiro<!----------- Description ----------> 23d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD> 24d0cef73dSGregory Neil Shapiro<TABLE border="1" cellspacing=1 cellpadding=4> 25d0cef73dSGregory Neil Shapiro<TR align="left" valign=top> 26d0cef73dSGregory Neil Shapiro<TH width="80">Called When</TH> 27d0cef73dSGregory 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> 28d0cef73dSGregory Neil Shapiro</TR> 29d0cef73dSGregory Neil Shapiro<TR align="left" valign=top> 30d0cef73dSGregory Neil Shapiro<TH width="80">Effects</TH> 31d0cef73dSGregory Neil Shapiro<TD>None.</TD> 32d0cef73dSGregory Neil Shapiro</TR> 33d0cef73dSGregory Neil Shapiro</TABLE> 34*5b0945b5SGregory Neil Shapiro</TD></TR> 3540266059SGregory Neil Shapiro 3640266059SGregory Neil Shapiro<!----------- Arguments ----------> 37d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD> 38d0cef73dSGregory Neil Shapiro <TABLE border="1" cellspacing=0> 39d0cef73dSGregory Neil Shapiro <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR> 40d0cef73dSGregory Neil Shapiro <TR valign="top"><TD>ctx</TD> 41d0cef73dSGregory Neil Shapiro <TD>The opaque context structure. 42d0cef73dSGregory Neil Shapiro </TD></TR> 43d0cef73dSGregory Neil Shapiro <TR valign="top"><TD>symname</TD> 44d0cef73dSGregory Neil Shapiro <TD>The name of a sendmail macro. 45739ac4d4SGregory Neil Shapiro Single letter macros can optionally be enclosed in braces ("{" and "}"), 46739ac4d4SGregory Neil Shapiro longer macro names must be enclosed in braces, just as in a 47d0cef73dSGregory Neil Shapiro <TT>sendmail.cf</TT> file. 48d0cef73dSGregory Neil Shapiro <A href="#notes">See below</A> for default macros. 49d0cef73dSGregory Neil Shapiro </TD></TR> 50d0cef73dSGregory Neil Shapiro </TABLE> 51d0cef73dSGregory Neil Shapiro</TD></TR> 5240266059SGregory Neil Shapiro 5340266059SGregory Neil Shapiro<!----------- Return values ----------> 54d0cef73dSGregory Neil Shapiro<TR> 55d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>RETURN VALUES</TH> 5640266059SGregory Neil Shapiro 57d0cef73dSGregory 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> 58d0cef73dSGregory Neil Shapiro</TR> 5940266059SGregory Neil Shapiro 6040266059SGregory Neil Shapiro<!----------- Notes ----------> 61d0cef73dSGregory Neil Shapiro<TR align="left" valign=top> 62d0cef73dSGregory Neil Shapiro<TH><A name="notes">NOTES</A></TH> 63d0cef73dSGregory Neil Shapiro<TD> 6440266059SGregory Neil ShapiroBy default, the following macros are valid in the given contexts: 6540266059SGregory Neil Shapiro 66d0cef73dSGregory Neil Shapiro<TABLE border="1" cellspacing=0> 67d0cef73dSGregory Neil Shapiro<TR bgcolor="#dddddd"><TH>Sent With</TH><TH>Macros</TH></TR> 68d0cef73dSGregory Neil Shapiro<TR><TD>xxfi_connect</TD> <TD>daemon_name, if_name, if_addr, j, _</TD></TR> 69d0cef73dSGregory Neil Shapiro<TR><TD>xxfi_helo</TD> <TD>tls_version, cipher, cipher_bits, cert_subject, cert_issuer</TD></TR> 70d0cef73dSGregory Neil Shapiro<TR><TD>xxfi_envfrom</TD> <TD>i, auth_type, auth_authen, auth_ssf, auth_author, 71d0cef73dSGregory Neil Shapiro mail_mailer, mail_host, mail_addr</TD></TR> 72d0cef73dSGregory Neil Shapiro<TR><TD>xxfi_envrcpt</TD> <TD>rcpt_mailer, rcpt_host, rcpt_addr</TD></TR> 73d0cef73dSGregory Neil Shapiro 74d0cef73dSGregory Neil Shapiro<TR><TD>xxfi_data</TD> <TD>(none)</TD></TR> 75d0cef73dSGregory Neil Shapiro<TR><TD>xxfi_eoh</TD> <TD>(none)</TD></TR> 76d0cef73dSGregory Neil Shapiro<TR><TD>xxfi_eom</TD> <TD>msg_id</TD></TR> 77d0cef73dSGregory Neil Shapiro</TABLE> 78d0cef73dSGregory Neil Shapiro<P> 79d0cef73dSGregory Neil ShapiroAll macros stay in effect from the point they are received 80d0cef73dSGregory Neil Shapirountil the end of the connection for the first two sets, 81d0cef73dSGregory Neil Shapirothe end of the message for the third (xxfi_envfrom) and last (xxfi_eom), 82d0cef73dSGregory Neil Shapiroand just for each recipient for xxfi_envrcpt. 83d0cef73dSGregory Neil Shapiro<P> 8440266059SGregory Neil ShapiroThe macro list can be changed using the confMILTER_MACROS_* options in 85d0cef73dSGregory Neil Shapirosendmail.mc. 86d0cef73dSGregory Neil ShapiroThe scopes of such macros will be determined by when they are set by sendmail. 87d0cef73dSGregory Neil ShapiroFor descriptions of macros' values, 88d0cef73dSGregory Neil Shapiroplease see the 89d0cef73dSGregory Neil Shapiro"Sendmail Installation and Operation Guide" 90d0cef73dSGregory Neil Shapiroprovided with your sendmail distribution. 9140266059SGregory Neil Shapiro 92d0cef73dSGregory Neil Shapiro</TD> 93d0cef73dSGregory Neil Shapiro</TR> 9440266059SGregory Neil Shapiro 95d0cef73dSGregory Neil Shapiro</TABLE> 9640266059SGregory Neil Shapiro 97d0cef73dSGregory Neil Shapiro<HR size="1"> 98d0cef73dSGregory Neil Shapiro<FONT size="-1"> 995dd76dd0SGregory Neil ShapiroCopyright (c) 2000, 2002-2003, 2007 Proofpoint, Inc. and its suppliers. 10040266059SGregory Neil ShapiroAll rights reserved. 101d0cef73dSGregory Neil Shapiro<BR> 10240266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set 1035ef517c0SGregory Neil Shapiroforth in the LICENSE. 104d0cef73dSGregory Neil Shapiro</FONT> 105d0cef73dSGregory Neil Shapiro</BODY> 106d0cef73dSGregory Neil Shapiro</HTML> 107