smfi_getsymval.3n (2010 09)
s
smfi_getsymval(3N) smfi_getsymval(3N)
NAME
smfi_getsymval() - gets the value of a sendmail macro
SYNOPSIS
#include <libmilter/mfapi.h>
char* smfi_getsymval(
SMFICTX *ctx,
);
PARAMETERS
ctx Specifies the opaque context structure.
symname Specifies the name of a
sendmail macro. Single letter macros can optionally be enclosed in
braces (
{ and }); longer macro names must be enclosed in braces, similar to the macro names
in the sendmail.cf file. For information on default macros, see the Notes section.
DESCRIPTION
The
smfi_getsymval()
routine can be called from any of the
xxfi_*() callback functions at any
time depending on the macros defined in
sendmail.
Notes
The following are default macros:
•
daemon_name, if_name, if_addr, j, _
These macros are sent with the xxfi_connect()
callback function.
•
tls_version, cipher, cipher_bits, cert_subject, cert_issuer
These macros are sent with the xxfi_helo() callback function.
•
i, auth_type, auth_authen, auth_ssf, auth_author, mail_mailer, mail_host,
mail_addr
These macros are sent with the xxfi_envfrom()
callback function.
•
rcpt_mailer, rcpt_host, rcpt_addr
These macros are sent with the xxfi_envrcpt()
callback function.
All macros specified with callback functions
xxfi_connect()
and xxfi_helo() are active from the
point they are received until the end of the connection.
All macros specified with the callback function
xxfi_envfrom()
are active from the point they are
received until the end of the message.
All macros specified with the callback function
xxfi_envrcpt()
are active for each recipient.
The macro list can be changed using the
confMILTER_MACROS_* options in the sendmail.mc file.
The scope of such macros is determined by when they are set by
sendmail.
RETURN VALUE
The
smfi_getsymval routine returns the value of the given macro as a null-terminated string.
smfi_getsymval returns NULL if the macro is not defined.
AUTHOR
The
smfi_getsymval() routine was developed by the Sendmail Inc.
SEE ALSO
smfi_getpriv(3N), smfi_setmlreply(3N), smfi_setreply(3N), smfi_setpriv(3N).
Sendmail 8.13.3 Programmer’s Guide on http://www.hp.com/go/hpux-networking-docs.
HP-UX 11i Version 3: September 2010 − 1 − Hewlett-Packard Company 1