1d0cef73dSGregory Neil Shapiro<HTML> 2d0cef73dSGregory Neil Shapiro<HEAD><TITLE>smfi_register</TITLE></HEAD> 3d0cef73dSGregory Neil Shapiro<BODY> 4e92d3f3fSGregory Neil Shapiro<!-- 5*4313cc83SGregory Neil Shapiro$Id: smfi_register.html,v 1.19 2013-11-22 20:51:39 ca Exp $ 6e92d3f3fSGregory Neil Shapiro--> 7d0cef73dSGregory Neil Shapiro<H1>smfi_register</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 Shapiroint smfi_register( 15a7ec597cSGregory Neil Shapiro smfiDesc descr 1640266059SGregory Neil Shapiro); 17d0cef73dSGregory Neil Shapiro</PRE> 1840266059SGregory Neil ShapiroRegister a set of filter callbacks. 19d0cef73dSGregory Neil Shapiro</TD></TR> 2040266059SGregory Neil Shapiro 2140266059SGregory Neil Shapiro<!----------- Description ----------> 22d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>DESCRIPTION</TH><TD> 23d0cef73dSGregory Neil Shapiro<TABLE border="1" cellspacing=1 cellpadding=1> 24d0cef73dSGregory Neil Shapiro<TR align="left" valign=top> 25d0cef73dSGregory Neil Shapiro<TH width="80">Called When</TH> 26d0cef73dSGregory Neil Shapiro<TD>smfi_register must be called before smfi_main</TD> 27d0cef73dSGregory Neil Shapiro</TR> 28d0cef73dSGregory Neil Shapiro<TR align="left" valign=top> 29d0cef73dSGregory Neil Shapiro<TH width="80">Effects</TH> 30d0cef73dSGregory Neil Shapiro<TD>smfi_register creates a filter using the information given in the 31d0cef73dSGregory Neil ShapirosmfiDesc argument. 32d0cef73dSGregory Neil ShapiroMultiple (successful) calls to smfi_register within a 33d0cef73dSGregory Neil Shapirosingle process are not allowed, 34d0cef73dSGregory Neil Shapiroi.e., only one filter can be successfully registered. 35d0cef73dSGregory Neil ShapiroNote, however, that the library may not check whether this restriction 36d0cef73dSGregory Neil Shapirois obeyed. 37d0cef73dSGregory Neil Shapiro</TD> 38d0cef73dSGregory Neil Shapiro</TR> 39d0cef73dSGregory Neil Shapiro</TABLE> 4040266059SGregory Neil Shapiro 4140266059SGregory Neil Shapiro<!----------- Arguments ----------> 42d0cef73dSGregory Neil Shapiro<TR><TH valign="top" align=left>ARGUMENTS</TH><TD> 43d0cef73dSGregory Neil Shapiro <TABLE border="1" cellspacing=0> 44d0cef73dSGregory Neil Shapiro <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR> 45d0cef73dSGregory Neil Shapiro <TR valign="top"><TD>descr</TD> 46d0cef73dSGregory Neil Shapiro <TD> 47d0cef73dSGregory Neil ShapiroA filter descriptor of type smfiDesc describing the filter's functions. 48d0cef73dSGregory Neil Shapiro<A NAME="smfiDesc">The structure</A> has the following members: 49d0cef73dSGregory Neil Shapiro<PRE> 5040266059SGregory Neil Shapirostruct smfiDesc 5140266059SGregory Neil Shapiro{ 5240266059SGregory Neil Shapiro char *xxfi_name; /* filter name */ 5340266059SGregory Neil Shapiro int xxfi_version; /* version code -- do not change */ 54d0cef73dSGregory Neil Shapiro unsigned long xxfi_flags; /* <A href="#flags">flags</A> */ 5540266059SGregory Neil Shapiro 5640266059SGregory Neil Shapiro /* connection info filter */ 57d0cef73dSGregory Neil Shapiro sfsistat (*<A href="xxfi_connect.html">xxfi_connect</A>)(SMFICTX *, char *, _SOCK_ADDR *); 5840266059SGregory Neil Shapiro /* SMTP HELO command filter */ 59d0cef73dSGregory Neil Shapiro sfsistat (*<A href="xxfi_helo.html">xxfi_helo</A>)(SMFICTX *, char *); 6040266059SGregory Neil Shapiro /* envelope sender filter */ 61d0cef73dSGregory Neil Shapiro sfsistat (*<A href="xxfi_envfrom.html">xxfi_envfrom</A>)(SMFICTX *, char **); 6240266059SGregory Neil Shapiro /* envelope recipient filter */ 63d0cef73dSGregory Neil Shapiro sfsistat (*<A href="xxfi_envrcpt.html">xxfi_envrcpt</A>)(SMFICTX *, char **); 6440266059SGregory Neil Shapiro /* header filter */ 65d0cef73dSGregory Neil Shapiro sfsistat (*<A href="xxfi_header.html">xxfi_header</A>)(SMFICTX *, char *, char *); 6640266059SGregory Neil Shapiro /* end of header */ 67d0cef73dSGregory Neil Shapiro sfsistat (*<A href="xxfi_eoh.html">xxfi_eoh</A>)(SMFICTX *); 6840266059SGregory Neil Shapiro /* body block */ 69d0cef73dSGregory Neil Shapiro sfsistat (*<A href="xxfi_body.html">xxfi_body</A>)(SMFICTX *, unsigned char *, size_t); 7040266059SGregory Neil Shapiro /* end of message */ 71d0cef73dSGregory Neil Shapiro sfsistat (*<A href="xxfi_eom.html">xxfi_eom</A>)(SMFICTX *); 7240266059SGregory Neil Shapiro /* message aborted */ 73d0cef73dSGregory Neil Shapiro sfsistat (*<A href="xxfi_abort.html">xxfi_abort</A>)(SMFICTX *); 7440266059SGregory Neil Shapiro /* connection cleanup */ 75d0cef73dSGregory Neil Shapiro sfsistat (*<A href="xxfi_close.html">xxfi_close</A>)(SMFICTX *); 7640266059SGregory Neil Shapiro 77d0cef73dSGregory Neil Shapiro /* any unrecognized or unimplemented command filter */ 78d0cef73dSGregory Neil Shapiro sfsistat (*xxfi_unknown)(SMFICTX *, const char *); 79d0cef73dSGregory Neil Shapiro 80d0cef73dSGregory Neil Shapiro /* SMTP DATA command filter */ 81d0cef73dSGregory Neil Shapiro sfsistat (*xxfi_data)(SMFICTX *); 82d0cef73dSGregory Neil Shapiro 83d0cef73dSGregory Neil Shapiro /* negotiation callback */ 84d0cef73dSGregory Neil Shapiro sfsistat (*<A HREF="xxfi_negotiate.html">xxfi_negotiate</A>)(SMFICTX *, 85d0cef73dSGregory Neil Shapiro unsigned long, unsigned long, unsigned long, unsigned long, 86d0cef73dSGregory Neil Shapiro unsigned long *, unsigned long *, unsigned long *, unsigned long *); 87d0cef73dSGregory Neil Shapiro}; 88d0cef73dSGregory Neil Shapiro</PRE> 89d0cef73dSGregory Neil Shapiro 90d0cef73dSGregory Neil ShapiroA NULL value for any callback function indicates that the filter 91d0cef73dSGregory Neil Shapirodoes not wish to process the given type of information, 92d0cef73dSGregory Neil Shapirosimply returning SMFIS_CONTINUE. 93d0cef73dSGregory Neil Shapiro </TD></TR> 94d0cef73dSGregory Neil Shapiro </TABLE> 95d0cef73dSGregory Neil Shapiro</TD></TR> 9640266059SGregory Neil Shapiro 9740266059SGregory Neil Shapiro<!----------- Return values ----------> 98d0cef73dSGregory Neil Shapiro<TR> 99d0cef73dSGregory Neil Shapiro<TH valign="top" align=left>RETURN VALUES</TH> 10040266059SGregory Neil Shapiro 101d0cef73dSGregory Neil Shapiro<TD> 10240266059SGregory Neil Shapirosmfi_register may return MI_FAILURE for any of the following reasons: 103d0cef73dSGregory Neil Shapiro<UL> 104d0cef73dSGregory Neil Shapiro<LI>memory allocation failed. 105d0cef73dSGregory Neil Shapiro<LI>incompatible version or illegal flags value. 106d0cef73dSGregory Neil Shapiro</UL> 10740266059SGregory Neil Shapiro 108d0cef73dSGregory Neil Shapiro</TD> 109d0cef73dSGregory Neil Shapiro</TR> 11040266059SGregory Neil Shapiro 11140266059SGregory Neil Shapiro<!----------- Notes ----------> 112d0cef73dSGregory Neil Shapiro<TR align="left" valign=top> 113d0cef73dSGregory Neil Shapiro<TH>NOTES</TH> 114d0cef73dSGregory Neil Shapiro<TD> 11540266059SGregory Neil Shapiro 116d0cef73dSGregory Neil Shapiro<A NAME="flags">The xxfi_flags</A> 117d0cef73dSGregory Neil Shapirofield should contain the bitwise OR of zero or more of 11840266059SGregory Neil Shapirothe following values, describing the actions the filter may take: 11940266059SGregory Neil Shapiro<TABLE BORDER CELLPADDING="1" cellspacing=1> 120d0cef73dSGregory Neil Shapiro<TR valign="top" bgcolor="#dddddd"><TH align="left">Flag</TH><TH align="center">Description</TH></TR> 12140266059SGregory Neil Shapiro <TR align="left" valign=top> 12240266059SGregory Neil Shapiro <TD> 12340266059SGregory Neil Shapiro SMFIF_ADDHDRS 12440266059SGregory Neil Shapiro </TD> 12540266059SGregory Neil Shapiro <TD> 126d0cef73dSGregory Neil Shapiro This filter may <A HREF="smfi_addheader.html">add headers</A>. 12740266059SGregory Neil Shapiro </TD> 12840266059SGregory Neil Shapiro </TR> 12940266059SGregory Neil Shapiro <TR align="left" valign=top> 13040266059SGregory Neil Shapiro <TD> 13140266059SGregory Neil Shapiro SMFIF_CHGHDRS 13240266059SGregory Neil Shapiro </TD> 13340266059SGregory Neil Shapiro <TD> 134d0cef73dSGregory Neil Shapiro This filter may 135d0cef73dSGregory Neil Shapiro <A HREF="smfi_chgheader.html">change and/or delete headers</A>. 13640266059SGregory Neil Shapiro </TD> 13740266059SGregory Neil Shapiro </TR> 13840266059SGregory Neil Shapiro <TR align="left" valign=top> 13940266059SGregory Neil Shapiro <TD VALIGN="TOP"> 14040266059SGregory Neil Shapiro SMFIF_CHGBODY 14140266059SGregory Neil Shapiro </TD> 14240266059SGregory Neil Shapiro <TD> 143d0cef73dSGregory Neil Shapiro This filter may 144d0cef73dSGregory Neil Shapiro <A HREF="smfi_replacebody.html">replace the body</A> during filtering. 14540266059SGregory Neil Shapiro This may have significant performance impact 14640266059SGregory Neil Shapiro if other filters do body filtering after this filter. 14740266059SGregory Neil Shapiro </TD> 14840266059SGregory Neil Shapiro </TR> 14940266059SGregory Neil Shapiro <TR> 15040266059SGregory Neil Shapiro <TD VALIGN="TOP"> 15140266059SGregory Neil Shapiro SMFIF_ADDRCPT 15240266059SGregory Neil Shapiro </TD> 15340266059SGregory Neil Shapiro <TD> 154d0cef73dSGregory Neil Shapiro This filter may 155d0cef73dSGregory Neil Shapiro <A HREF="smfi_addrcpt.html">add recipients</A> 156d0cef73dSGregory Neil Shapiro to the message. 157d0cef73dSGregory Neil Shapiro </TD> 158d0cef73dSGregory Neil Shapiro </TR> 159d0cef73dSGregory Neil Shapiro <TR> 160d0cef73dSGregory Neil Shapiro <TD VALIGN="TOP"> 161d0cef73dSGregory Neil Shapiro SMFIF_ADDRCPT_PAR 162d0cef73dSGregory Neil Shapiro </TD> 163d0cef73dSGregory Neil Shapiro <TD> 164d0cef73dSGregory Neil Shapiro This filter may 165d0cef73dSGregory Neil Shapiro <A HREF="smfi_addrcpt_par.html">add recipients including ESMTP args</A>. 16640266059SGregory Neil Shapiro </TD> 16740266059SGregory Neil Shapiro </TR> 16840266059SGregory Neil Shapiro <TR> 16940266059SGregory Neil Shapiro <TD VALIGN="TOP"> 17040266059SGregory Neil Shapiro SMFIF_DELRCPT 17140266059SGregory Neil Shapiro </TD> 17240266059SGregory Neil Shapiro <TD> 173d0cef73dSGregory Neil Shapiro This filter may 174d0cef73dSGregory Neil Shapiro <A HREF="smfi_delrcpt.html">remove recipients</A> from the message. 17540266059SGregory Neil Shapiro </TD> 17640266059SGregory Neil Shapiro </TR> 177d0cef73dSGregory Neil Shapiro <TR> 178d0cef73dSGregory Neil Shapiro <TD VALIGN="TOP"> 179d0cef73dSGregory Neil Shapiro SMFIF_QUARANTINE 180d0cef73dSGregory Neil Shapiro </TD> 181d0cef73dSGregory Neil Shapiro <TD> 182d0cef73dSGregory Neil Shapiro This filter may 183d0cef73dSGregory Neil Shapiro <A HREF="smfi_quarantine.html">quarantine</A> a message. 184d0cef73dSGregory Neil Shapiro </TD> 185d0cef73dSGregory Neil Shapiro </TR> 186d0cef73dSGregory Neil Shapiro 187d0cef73dSGregory Neil Shapiro <TR> 188d0cef73dSGregory Neil Shapiro <TD VALIGN="TOP"> 189d0cef73dSGregory Neil Shapiro SMFIF_CHGFROM 190d0cef73dSGregory Neil Shapiro </TD> 191d0cef73dSGregory Neil Shapiro <TD> 192d0cef73dSGregory Neil Shapiro This filter may 193d0cef73dSGregory Neil Shapiro <A HREF="smfi_chgfrom.html">change the envelope sender</A> (MAIL). 194d0cef73dSGregory Neil Shapiro </TD> 195d0cef73dSGregory Neil Shapiro </TR> 196d0cef73dSGregory Neil Shapiro 197d0cef73dSGregory Neil Shapiro <TR> 198d0cef73dSGregory Neil Shapiro <TD VALIGN="TOP"> 199d0cef73dSGregory Neil Shapiro SMFIF_SETSYMLIST 200d0cef73dSGregory Neil Shapiro </TD> 201d0cef73dSGregory Neil Shapiro <TD> 202d0cef73dSGregory Neil Shapiro This filter can 203d0cef73dSGregory Neil Shapiro <A HREF="smfi_setsymlist.html">send a set of symbols (macros)</A> 204d0cef73dSGregory Neil Shapiro that it wants. 205d0cef73dSGregory Neil Shapiro </TD> 206d0cef73dSGregory Neil Shapiro </TR> 207d0cef73dSGregory Neil Shapiro 20840266059SGregory Neil Shapiro</TABLE> 20940266059SGregory Neil Shapiro 210d0cef73dSGregory Neil Shapiro</TD> 211d0cef73dSGregory Neil Shapiro</TR> 21240266059SGregory Neil Shapiro 213d0cef73dSGregory Neil Shapiro</TABLE> 21440266059SGregory Neil Shapiro 215d0cef73dSGregory Neil Shapiro<HR size="1"> 216d0cef73dSGregory Neil Shapiro<FONT size="-1"> 2175dd76dd0SGregory Neil ShapiroCopyright (c) 2000-2001, 2003, 2006 Proofpoint, Inc. and its suppliers. 21840266059SGregory Neil ShapiroAll rights reserved. 219d0cef73dSGregory Neil Shapiro<BR> 22040266059SGregory Neil ShapiroBy using this file, you agree to the terms and conditions set 2215ef517c0SGregory Neil Shapiroforth in the LICENSE. 222d0cef73dSGregory Neil Shapiro</FONT> 223d0cef73dSGregory Neil Shapiro</BODY> 224d0cef73dSGregory Neil Shapiro</HTML> 225