1<HTML> 2<HEAD><TITLE>smfi_delrcpt</TITLE></HEAD> 3<BODY> 4<!-- 5$Id: smfi_delrcpt.html,v 1.12 2013-11-22 20:51:39 ca Exp $ 6--> 7<H1>smfi_delrcpt</H1> 8 9<TABLE border="0" cellspacing=4 cellpadding=4> 10<!---------- Synopsis -----------> 11<TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD> 12<PRE> 13#include <libmilter/mfapi.h> 14int smfi_delrcpt( 15 SMFICTX *ctx; 16 char *rcpt; 17); 18</PRE> 19Remove a recipient from the current message's envelope. 20</TD></TR> 21 22<!----------- Description ----------> 23<TR><TH valign="top" align=left>DESCRIPTION</TH><TD> 24<TABLE border="1" cellspacing=1 cellpadding=4> 25<TR align="left" valign=top> 26<TH width="80">Called When</TH> 27<TD>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD> 28</TR> 29<TR align="left" valign=top> 30<TH width="80">Effects</TH> 31<TD>smfi_delrcpt removes the named recipient from the current message's envelope.</TD> 32</TR> 33</TABLE> 34</TD></TR> 35 36<!----------- Arguments ----------> 37<TR><TH valign="top" align=left>ARGUMENTS</TH><TD> 38 <TABLE border="1" cellspacing=0> 39 <TR bgcolor="#dddddd"><TH>Argument</TH><TH>Description</TH></TR> 40 <TR valign="top"><TD>ctx</TD> 41 <TD>Opaque context structure. 42 </TD></TR> 43 <TR valign="top"><TD>rcpt</TD> 44 <TD>The recipient address to be removed, a non-NULL, null-terminated string. 45 </TD></TR> 46 </TABLE> 47</TD></TR> 48 49<!----------- Return values ----------> 50<TR> 51<TH valign="top" align=left>RETURN VALUES</TH> 52 53<TD>smfi_delrcpt will fail and return MI_FAILURE if: 54<UL> 55 <LI>rcpt is NULL. 56 <LI>Deleting recipients in the current connection state is invalid. 57 <LI>A network error occurs. 58 <LI><A HREF="smfi_register.html#SMFIF_DELRCPT">SMFIF_DELRCPT</A> is not set. 59</UL> 60Otherwise, it will return MI_SUCCESS 61</TD> 62</TR> 63 64<!----------- Notes ----------> 65<TR align="left" valign=top> 66<TH>NOTES</TH> 67<TD> 68<LI> 69The addresses to be removed must match exactly. For example, an address and its expanded form do not match. 70<LI> 71A filter which calls smfi_delrcpt must have set the 72<A HREF="smfi_register.html#SMFIF_DELRCPT">SMFIF_DELRCPT</A> flag. 73</TD> 74</TR> 75 76</TABLE> 77 78<HR size="1"> 79<FONT size="-1"> 80Copyright (c) 2000, 2003 Proofpoint, Inc. and its suppliers. 81All rights reserved. 82<BR> 83By using this file, you agree to the terms and conditions set 84forth in the LICENSE. 85</FONT> 86</BODY> 87</HTML> 88