smfi_delrcpt.html revision 132943
12353Sjlahoda<html> 23314Sjjg<head><title>smfi_delrcpt</title></head> 32353Sjlahoda<body> 42353Sjlahoda<!-- 52353Sjlahoda$Id: smfi_delrcpt.html,v 1.9 2003/10/27 15:51:12 ca Exp $ 62353Sjlahoda--> 72353Sjlahoda<h1>smfi_delrcpt</h1> 82353Sjlahoda 92353Sjlahoda<table border="0" cellspacing=4 cellpadding=4> 102353Sjlahoda<!---------- Synopsis -----------> 112353Sjlahoda<tr><th valign="top" align=left width=150>SYNOPSIS</th><td> 122353Sjlahoda<pre> 132353Sjlahoda#include <libmilter/mfapi.h> 142353Sjlahodaint smfi_delrcpt( 152353Sjlahoda SMFICTX *ctx; 162353Sjlahoda char *rcpt; 172353Sjlahoda); 182353Sjlahoda</pre> 192353SjlahodaRemove a recipient from the current message's envelope. 202353Sjlahoda</td></tr> 212353Sjlahoda 222353Sjlahoda<!----------- Description ----------> 232353Sjlahoda<tr><th valign="top" align=left>DESCRIPTION</th><td> 242353Sjlahoda<table border="1" cellspacing=1 cellpadding=4> 252353Sjlahoda<tr align="left" valign=top> 262353Sjlahoda<th width="80">Called When</th> 272353Sjlahoda<td>Called only from <a href="xxfi_eom.html">xxfi_eom</a>.</td> 282353Sjlahoda</tr> 292586Sjjg<tr align="left" valign=top> 302933Sakulyakh<th width="80">Effects</th> 312933Sakulyakh<td>smfi_delrcpt removes the named recipient from the current message's envelope.</td> 323294Salanb</tr> 333314Sjjg</table> 342353Sjlahoda 352353Sjlahoda<!----------- Arguments ----------> 362353Sjlahoda<tr><th valign="top" align=left>ARGUMENTS</th><td> 372353Sjlahoda <table border="1" cellspacing=0> 382353Sjlahoda <tr bgcolor="#dddddd"><th>Argument</th><th>Description</th></tr> 392353Sjlahoda <tr valign="top"><td>ctx</td> 402353Sjlahoda <td>Opaque context structure. 412353Sjlahoda </td></tr> 422353Sjlahoda <tr valign="top"><td>rcpt</td> 432353Sjlahoda <td>The recipient address to be removed, a non-NULL, null-terminated string. 442353Sjlahoda </td></tr> 452353Sjlahoda </table> 462353Sjlahoda</td></tr> 473314Sjjg 483314Sjjg<!----------- Return values ----------> 492353Sjlahoda<tr> 502353Sjlahoda<th valign="top" align=left>RETURN VALUES</th> 512353Sjlahoda 522353Sjlahoda<td>smfi_delrcpt will fail and return MI_FAILURE if: 532353Sjlahoda<ul> 542353Sjlahoda <li>rcpt is NULL. 552353Sjlahoda <li>Deleting recipients in the current connection state is invalid. 562353Sjlahoda <li>A network error occurs. 572353Sjlahoda <li>SMFIF_DELRCPT was not set when <a href="smfi_register.html">smfi_register</a> was called. 582353Sjlahoda</ul> 592353SjlahodaOtherwise, it will return MI_SUCCESS 602353Sjlahoda</td> 612353Sjlahoda</tr> 622353Sjlahoda 632353Sjlahoda<!----------- Notes ----------> 642353Sjlahoda<tr align="left" valign=top> 652353Sjlahoda<th>NOTES</th> 662353Sjlahoda<td> 672353SjlahodaThe addresses to be removed must match exactly. For example, an address and its expanded form do not match. 682353Sjlahoda</td> 692353Sjlahoda</tr> 70 71</table> 72 73<hr size="1"> 74<font size="-1"> 75Copyright (c) 2000, 2003 Sendmail, Inc. and its suppliers. 76All rights reserved. 77<br> 78By using this file, you agree to the terms and conditions set 79forth in the LICENSE. 80</font> 81</body> 82</html> 83