diff options
Diffstat (limited to 'contrib/sendmail/libmilter/docs/smfi_getsymval.html')
| -rw-r--r-- | contrib/sendmail/libmilter/docs/smfi_getsymval.html | 144 |
1 files changed, 75 insertions, 69 deletions
diff --git a/contrib/sendmail/libmilter/docs/smfi_getsymval.html b/contrib/sendmail/libmilter/docs/smfi_getsymval.html index 0e9bc58..671dbfa 100644 --- a/contrib/sendmail/libmilter/docs/smfi_getsymval.html +++ b/contrib/sendmail/libmilter/docs/smfi_getsymval.html @@ -1,99 +1,105 @@ -<html> -<head><title>smfi_getsymval</title></head> -<body> +<HTML> +<HEAD><TITLE>smfi_getsymval</TITLE></HEAD> +<BODY> <!-- -$Id: smfi_getsymval.html,v 1.10 2003/03/05 19:57:54 ca Exp $ +$Id: smfi_getsymval.html,v 1.15 2007/03/19 16:49:11 ca Exp $ --> -<h1>smfi_getsymval</h1> +<H1>smfi_getsymval</H1> -<table border="0" cellspacing=4 cellpadding=4> +<TABLE border="0" cellspacing=4 cellpadding=4> <!---------- Synopsis -----------> -<tr><th valign="top" align=left width=150>SYNOPSIS</th><td> -<pre> +<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD> +<PRE> #include <libmilter/mfapi.h> char* smfi_getsymval( SMFICTX *ctx, char *symname ); -</pre> +</PRE> Get the value of a sendmail macro. -</td></tr> +</TD></TR> <!----------- Description ----------> -<tr><th valign="top" align=left>DESCRIPTION</th><td> -<table border="1" cellspacing=1 cellpadding=4> -<tr align="left" valign=top> -<th width="80">Called When</th> -<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> -</tr> -<tr align="left" valign=top> -<th width="80">Effects</th> -<td>None.</td> -</tr> -</table> +<TR><TH valign="top" align=left>DESCRIPTION</TH><TD> +<TABLE border="1" cellspacing=1 cellpadding=4> +<TR align="left" valign=top> +<TH width="80">Called When</TH> +<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> +</TR> +<TR align="left" valign=top> +<TH width="80">Effects</TH> +<TD>None.</TD> +</TR> +</TABLE> <!----------- Arguments ----------> -<tr><th valign="top" align=left>ARGUMENTS</th><td> - <table border="1" cellspacing=0> - <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr> - <tr valign="top"><td>ctx</td> - <td>The opaque context structure. - </td></tr> - <tr valign="top"><td>symname</td> - <td>The name of a sendmail macro. +<TR><TH valign="top" align=left>ARGUMENTS</TH><TD> + <TABLE border="1" cellspacing=0> + <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR> + <TR valign="top"><TD>ctx</TD> + <TD>The opaque context structure. + </TD></TR> + <TR valign="top"><TD>symname</TD> + <TD>The name of a sendmail macro. Single letter macros can optionally be enclosed in braces ("{" and "}"), longer macro names must be enclosed in braces, just as in a - <tt>sendmail.cf</tt> file. - <a href="#notes">See below</a> for default macros. - </td></tr> - </table> -</td></tr> + <TT>sendmail.cf</TT> file. + <A href="#notes">See below</A> for default macros. + </TD></TR> + </TABLE> +</TD></TR> <!----------- Return values ----------> -<tr> -<th valign="top" align=left>RETURN VALUES</th> +<TR> +<TH valign="top" align=left>RETURN VALUES</TH> -<td>smfi_getsymval returns the value of the given macro as a null-terminated string, or NULL if the macro is not defined.</td> -</tr> +<TD>smfi_getsymval returns the value of the given macro as a null-terminated string, or NULL if the macro is not defined.</TD> +</TR> <!----------- Notes ----------> -<tr align="left" valign=top> -<th><a name="notes">NOTES</A></th> -<td> +<TR align="left" valign=top> +<TH><A name="notes">NOTES</A></TH> +<TD> By default, the following macros are valid in the given contexts: -<table border="1" cellspacing=0> -<tr bgcolor="#dddddd"><th>Sent With</th><th>Macros</th></tr> -<tr><td>xxfi_connect</td> <td>daemon_name, if_name, if_addr, j, _</td></tr> -<tr><td>xxfi_helo</td> <td>tls_version, cipher, cipher_bits, cert_subject, cert_issuer</td></tr> -<tr><td>xxfi_envfrom</td> <td>i, auth_type, auth_authen, auth_ssf, auth_author, - mail_mailer, mail_host, mail_addr</td></tr> -<tr><td>xxfi_envrcpt</td> <td>rcpt_mailer, rcpt_host, rcpt_addr</td></tr> -</table> -<p> -All macros stay in effect from the point they are received until the -end of the connection for the first two sets, the end of the message -for the third (xxfi_envfrom), and just for each recipient for the -final set (xxfi_envrcpt). -<p> +<TABLE border="1" cellspacing=0> +<TR bgcolor="#dddddd"><TH>Sent With</TH><TH>Macros</TH></TR> +<TR><TD>xxfi_connect</TD> <TD>daemon_name, if_name, if_addr, j, _</TD></TR> +<TR><TD>xxfi_helo</TD> <TD>tls_version, cipher, cipher_bits, cert_subject, cert_issuer</TD></TR> +<TR><TD>xxfi_envfrom</TD> <TD>i, auth_type, auth_authen, auth_ssf, auth_author, + mail_mailer, mail_host, mail_addr</TD></TR> +<TR><TD>xxfi_envrcpt</TD> <TD>rcpt_mailer, rcpt_host, rcpt_addr</TD></TR> + +<TR><TD>xxfi_data</TD> <TD>(none)</TD></TR> +<TR><TD>xxfi_eoh</TD> <TD>(none)</TD></TR> +<TR><TD>xxfi_eom</TD> <TD>msg_id</TD></TR> +</TABLE> +<P> +All macros stay in effect from the point they are received +until the end of the connection for the first two sets, +the end of the message for the third (xxfi_envfrom) and last (xxfi_eom), +and just for each recipient for xxfi_envrcpt. +<P> The macro list can be changed using the confMILTER_MACROS_* options in -sendmail.mc. The scopes of such macros will be determined by when -they are set by sendmail. For descriptions of macros' values, please -see the "Sendmail Installation and Operation Guide" provided with your -sendmail distribution. +sendmail.mc. +The scopes of such macros will be determined by when they are set by sendmail. +For descriptions of macros' values, +please see the +"Sendmail Installation and Operation Guide" +provided with your sendmail distribution. -</td> -</tr> +</TD> +</TR> -</table> +</TABLE> -<hr size="1"> -<font size="-1"> -Copyright (c) 2000, 2002-2003 Sendmail, Inc. and its suppliers. +<HR size="1"> +<FONT size="-1"> +Copyright (c) 2000, 2002-2003, 2007 Sendmail, Inc. and its suppliers. All rights reserved. -<br> +<BR> By using this file, you agree to the terms and conditions set forth in the LICENSE. -</font> -</body> -</html> +</FONT> +</BODY> +</HTML> |
