<HTML> <HEAD><TITLE>smfi_delrcpt</TITLE></HEAD> <BODY> <!-- $Id: smfi_delrcpt.html,v 1.12 2013-11-22 20:51:39 ca Exp $ --> <H1>smfi_delrcpt</H1> <TABLE border="0" cellspacing=4 cellpadding=4> <!---------- Synopsis -----------> <TR><TH valign="top" align=left width=100>SYNOPSIS</TH><TD> <PRE> #include <libmilter/mfapi.h> int smfi_delrcpt( SMFICTX *ctx; char *rcpt; ); </PRE> Remove a recipient from the current message's envelope. </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>Called only from <A href="xxfi_eom.html">xxfi_eom</A>.</TD> </TR> <TR align="left" valign=top> <TH width="80">Effects</TH> <TD>smfi_delrcpt removes the named recipient from the current message's envelope.</TD> </TR> </TABLE> </TD></TR> <!----------- 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>Opaque context structure. </TD></TR> <TR valign="top"><TD>rcpt</TD> <TD>The recipient address to be removed, a non-NULL, null-terminated string. </TD></TR> </TABLE> </TD></TR> <!----------- Return values ----------> <TR> <TH valign="top" align=left>RETURN VALUES</TH> <TD>smfi_delrcpt will fail and return MI_FAILURE if: <UL> <LI>rcpt is NULL. <LI>Deleting recipients in the current connection state is invalid. <LI>A network error occurs. <LI><A HREF="smfi_register.html#SMFIF_DELRCPT">SMFIF_DELRCPT</A> is not set. </UL> Otherwise, it will return MI_SUCCESS </TD> </TR> <!----------- Notes ----------> <TR align="left" valign=top> <TH>NOTES</TH> <TD> <LI> The addresses to be removed must match exactly. For example, an address and its expanded form do not match. <LI> A filter which calls smfi_delrcpt must have set the <A HREF="smfi_register.html#SMFIF_DELRCPT">SMFIF_DELRCPT</A> flag. </TD> </TR> </TABLE> <HR size="1"> <FONT size="-1"> Copyright (c) 2000, 2003 Proofpoint, Inc. and its suppliers. All rights reserved. <BR> By using this file, you agree to the terms and conditions set forth in the LICENSE. </FONT> </BODY> </HTML> |