contrib/sendmail/libmilter/docs/api.html

   1 <HTML>
   2 <HEAD><TITLE>Milter API</TITLE></HEAD>
   3 <BODY>
   4 <!--
   5 $Id: api.html,v 1.39 2013-11-22 20:51:39 ca Exp $
   6 -->
   7 <H1>Milter API</H1>
   8
   9 <H2>Contents</H2>
  10 <UL>
  11     <LI><A HREF="#LibraryControlFunctions">Library Control Functions</A>
  12     <LI><A HREF="#DataAccessFunctions">Data Access Functions</A>
  13     <LI><A HREF="#MessageModificationFunctions">Message Modification Functions</A>
  14     <LI><A HREF="#Callbacks">Callbacks</A>
  15     <LI><A HREF="#Miscellaneous">Miscellaneous</A>
  16 </UL>
  17
  18 <H2><A NAME="LibraryControlFunctions">Library Control Functions</A></H2>
  19
  20 Before handing control to libmilter (by calling
  21 <A HREF="smfi_main.html">smfi_main</A>), a filter may call the following
  22 functions to set libmilter parameters.
  23 In particular, the filter must call
  24 <A HREF="smfi_register.html">smfi_register</A> to register its callbacks.
  25 Each function will return either MI_SUCCESS or MI_FAILURE to
  26 indicate the status of the operation.
  27
  28 <P>
  29 None of these functions communicate with the MTA.  All alter the
  30 library's state, some of which is communicated to the MTA inside
  31 <A HREF="smfi_main.html">smfi_main</A>.
  32
  33 <P>
  34 <TABLE BORDER="1" CELLSPACING=0 CELLPADDING=2><TR BGCOLOR="#dddddd"><TH>Function</TH><TH>Description</TH></TR>
  35
  36 <TR><TD><A HREF="smfi_opensocket.html">smfi_opensocket</A></TD><TD>Try to create the interface socket.</TD></TR>
  37
  38 <TR><TD><A HREF="smfi_register.html">smfi_register</A></TD><TD>Register a filter.</TD></TR>
  39
  40 <TR><TD><A HREF="smfi_setconn.html">smfi_setconn</A></TD><TD>Specify socket to use.</TD></TR>
  41
  42 <TR><TD><A HREF="smfi_settimeout.html">smfi_settimeout</A></TD><TD>Set timeout.</TD></TR>
  43
  44 <TR><TD><A HREF="smfi_setbacklog.html">smfi_setbacklog</A></TD><TD>Define the incoming <CODE>listen(2)</CODE> queue size.</TD></TR>
  45
  46 <TR><TD><A HREF="smfi_setdbg.html">smfi_setdbg</A></TD><TD>Set the milter library debugging (tracing) level.</TD></TR>
  47
  48 <TR><TD><A HREF="smfi_stop.html">smfi_stop</A></TD><TD>Cause an orderly shutdown.</TD></TR>
  49
  50 <TR><TD><A HREF="smfi_main.html">smfi_main</A></TD><TD>Hand control to libmilter.</TD></TR>
  51
  52 </TABLE>
  53
  54 <H2><A NAME="DataAccessFunctions">Data Access Functions</A></H2>
  55
  56 The following functions may be called from within the filter-defined callbacks
  57 to access information about the current connection or message.
  58 <P>
  59 <TABLE BORDER="1" CELLSPACING=0 CELLPADDING=2><TR bgcolor="#dddddd"><TH>Function</TH><TH>Description</TH></TR>
  60 <TR><TD><A HREF="smfi_getsymval.html">smfi_getsymval</A></TD><TD>Return the value
  61 of a symbol.</TD></TR>
  62
  63 <TR><TD><A HREF="smfi_getpriv.html">smfi_getpriv</A></TD><TD>Get the private data
  64 pointer.</TD></TR>
  65
  66 <TR><TD><A HREF="smfi_setpriv.html">smfi_setpriv</A></TD><TD>Set the private data
  67 pointer.</TD></TR>
  68
  69 <TR><TD><A HREF="smfi_setreply.html">smfi_setreply</A></TD><TD>Set the specific
  70 reply code to be used.</TD></TR>
  71
  72 <TR><TD><A HREF="smfi_setmlreply.html">smfi_setmlreply</A></TD><TD>Set the
  73 specific multi-line reply to be used.</TD></TR>
  74
  75 </TABLE>
  76
  77 <H2><A NAME="MessageModificationFunctions">Message Modification Functions</A></H2>
  78
  79 The following functions change a message's contents and attributes.
  80 <EM>They may only be called in <A HREF="xxfi_eom.html">xxfi_eom</A></EM>.
  81 All of these functions may invoke additional communication with the MTA.
  82 They will return either MI_SUCCESS or MI_FAILURE to indicate the status of
  83 the operation.  Message data (senders, recipients, headers, body chunks)
  84 passed to these functions via parameters is copied and does not need to be
  85 preserved (i.e., allocated memory can be freed).
  86
  87 <P>
  88 A filter must have set the appropriate flag (listed below) in the
  89 description passed to <A HREF="smfi_register.html">smfi_register</A>
  90 to call any message modification function.  Failure to do so will
  91 cause the MTA to treat a call to the function as a failure of the
  92 filter, terminating its connection.
  93
  94 <P>
  95 Note that the status returned indicates only whether or not the
  96 filter's message was successfully sent to the MTA, not whether or not
  97 the MTA performed the requested operation.  For example,
  98 <A HREF="smfi_addheader.html">smfi_addheader</A>, when called with an
  99 illegal header name, will return MI_SUCCESS even though the MTA may
 100 later refuse to add the illegal header.
 101 <P>
 102 <TABLE BORDER="1" CELLSPACING=0 CELLPADDING=2><TR BGCOLOR="#dddddd"><TH>Function</TH><TH>Description</TH><TH>SMFIF_* flag</TR>
 103 <TR><TD><A HREF="smfi_addheader.html">smfi_addheader</A></TD><TD>Add a header to
 104 the message.</TD><TD>SMFIF_ADDHDRS</TD></TR>
 105
 106 <TR><TD><A HREF="smfi_chgheader.html">smfi_chgheader</A></TD><TD>Change or delete a header.</TD><TD>SMFIF_CHGHDRS</TD></TR>
 107
 108 <TR><TD><A HREF="smfi_insheader.html">smfi_insheader</A></TD><TD>Insert a
 109 header into the message.</TD><TD>SMFIF_ADDHDRS</TD></TR>
 110
 111 <TR><TD><A HREF="smfi_chgfrom.html">smfi_chgfrom</A></TD><TD>Change the
 112 envelope sender address.</TD><TD>SMFIF_CHGFROM</TD></TR>
 113
 114 <TR><TD><A HREF="smfi_addrcpt.html">smfi_addrcpt</A></TD><TD>Add a recipient to
 115 the envelope.</TD><TD>SMFIF_ADDRCPT</TD></TR>
 116
 117 <TR><TD><A HREF="smfi_addrcpt_par.html">smfi_addrcpt_par</A></TD><TD>Add
 118 a recipient including ESMTP parameter to the envelope.
 119 </TD><TD>SMFIF_ADDRCPT_PAR</TD></TR>
 120
 121 <TR><TD><A HREF="smfi_delrcpt.html">smfi_delrcpt</A></TD><TD>Delete a recipient
 122 from the envelope.</TD><TD>SMFIF_DELRCPT</TD></TR>
 123
 124 <TR><TD><A HREF="smfi_replacebody.html">smfi_replacebody</A></TD><TD>Replace the
 125 body of the message.</TD><TD>SMFIF_CHGBODY</TD></TR>
 126
 127 </TABLE>
 128
 129 <H2>Other Message Handling Functions</H2>
 130
 131 The following functions provide special case handling instructions for
 132 milter or the MTA, without altering the content or status of the message.
 133 <EM>They too may only be called in <A HREF="xxfi_eom.html">xxfi_eom</A></EM>.
 134 All of these functions may invoke additional communication with the MTA.
 135 They will return either MI_SUCCESS or MI_FAILURE to indicate the status of
 136 the operation.
 137
 138 <P>
 139 Note that the status returned indicates only whether or not the
 140 filter's message was successfully sent to the MTA, not whether or not
 141 the MTA performed the requested operation.
 142
 143 <P>
 144 <TABLE BORDER="1" CELLSPACING=0 CELLPADDING=2><TR BGCOLOR="#dddddd"><TH>Function</TH><TH>Description</TH></TR>
 145 <TR><TD><A HREF="smfi_progress.html">smfi_progress</A></TD><TD>Report operation in progress.</TD></TR>
 146
 147 <TR><TD><A HREF="smfi_quarantine.html">smfi_quarantine</A></TD><TD>Quarantine a message.</TD></TR>
 148
 149 </TABLE>
 150
 151 <H2><A NAME="Callbacks">Callbacks</A></H2>
 152
 153 The filter should implement one or more of the following callbacks,
 154 which are registered via <A HREF="smfi_register.html">smfi_register</A>:
 155
 156 <P>
 157 <TABLE BORDER="1" CELLSPACING=0 CELLPADDING=2><TR BGCOLOR="#dddddd"><TH>Function</TH><TH>Description</TH></TR>
 158
 159 <TR><TD><A HREF="xxfi_connect.html">xxfi_connect</A></TD><TD>connection info</TD></TR>
 160
 161 <TR><TD><A HREF="xxfi_helo.html">xxfi_helo</A></TD><TD>SMTP HELO/EHLO command</TD></TR>
 162
 163 <TR><TD><A HREF="xxfi_envfrom.html">xxfi_envfrom</A></TD><TD>envelope sender</TD></TR>
 164
 165 <TR><TD><A HREF="xxfi_envrcpt.html">xxfi_envrcpt</A></TD><TD>envelope recipient</TD></TR>
 166
 167 <TR><TD><A HREF="xxfi_data.html">xxfi_data</A></TD><TD>DATA command</TD></TR>
 168
 169 <TR><TD><A HREF="xxfi_unknown.html">xxfi_unknown</A></TD><TD>Unknown SMTP command</TD></TR>
 170
 171 <TR><TD><A HREF="xxfi_header.html">xxfi_header</A></TD><TD>header</TD></TR>
 172
 173 <TR><TD><A HREF="xxfi_eoh.html">xxfi_eoh</A></TD><TD>end of header</TD></TR>
 174
 175 <TR><TD><A HREF="xxfi_body.html">xxfi_body</A></TD><TD>body block</TD></TR>
 176
 177 <TR><TD><A HREF="xxfi_eom.html">xxfi_eom</A></TD><TD>end of message</TD></TR>
 178
 179 <TR><TD><A HREF="xxfi_abort.html">xxfi_abort</A></TD><TD>message aborted</TD></TR>
 180
 181 <TR><TD><A HREF="xxfi_close.html">xxfi_close</A></TD><TD>connection cleanup</TD></TR>
 182
 183 <TR><TD><A HREF="xxfi_negotiate.html">xxfi_negotiate</A></TD><TD>option negotiattion</TD></TR>
 184
 185 </TABLE>
 186
 187 <P>
 188 The above callbacks should all return one of the following return values,
 189 having the indicated meanings.  Any return other than one of the below
 190 values constitutes an error, and will cause sendmail to terminate its
 191 connection to the offending filter.
 192
 193 <P><A NAME="conn-spec">Milter</A> distinguishes between recipient-,
 194 message-, and connection-oriented routines.  Recipient-oriented
 195 callbacks may affect the processing of a single message recipient;
 196 message-oriented callbacks, a single message; connection-oriented
 197 callbacks, an entire connection (during which multiple messages may be
 198 delivered to multiple sets of recipients).
 199 <A HREF="xxfi_envrcpt.html">xxfi_envrcpt</A> is recipient-oriented.
 200 <A HREF="xxfi_connect.html">xxfi_connect</A>,
 201 <A HREF="xxfi_helo.html">xxfi_helo</A> and
 202 <A HREF="xxfi_close.html">xxfi_close</A> are connection-oriented.  All
 203 other callbacks are message-oriented.
 204
 205 <P>
 206 <TABLE BORDER="1" CELLSPACING=0 CELLPADDING=2>
 207   <TR BGCOLOR="#dddddd"><TH>Return value</TH><TH>Description</TH></TR>
 208   <TR VALIGN="TOP">
 209      <TD>SMFIS_CONTINUE</TD>
 210      <TD>Continue processing the current connection, message, or recipient.
 211      </TD>
 212   </TR>
 213   <TR VALIGN="TOP">
 214      <TD>SMFIS_REJECT</TD>
 215      <TD>For a connection-oriented routine, reject this connection; call <A HREF="xxfi_close.html">xxfi_close</A>.<BR>
 216         For a message-oriented routine (except
 217         <A HREF="xxfi_abort.html">xxfi_abort</A>), reject this message.<BR>
 218         For a recipient-oriented routine, reject the current recipient (but continue processing the current message).
 219      </TD>
 220   </TR>
 221   <TR valign="top">
 222      <TD>SMFIS_DISCARD</TD>
 223      <TD>For a message- or recipient-oriented routine, accept this message, but silently discard it.<BR>
 224      SMFIS_DISCARD should not be returned by a connection-oriented routine.
 225      </TD>
 226   </TR>
 227   <TR valign="top">
 228      <TD>SMFIS_ACCEPT</TD>
 229      <TD>For a connection-oriented routine, accept this connection without further filter processing; call <A HREF="xxfi_close.html">xxfi_close</A>.<BR>
 230          For a message- or recipient-oriented routine, accept this message without further filtering.<BR>
 231      </TD>
 232   </TR>
 233   <TR valign="top">
 234      <TD>SMFIS_TEMPFAIL</TD>
 235      <TD>Return a temporary failure, i.e., the corresponding SMTP command will return an appropriate 4xx status code.
 236          For a message-oriented routine (except <A HREF="xxfi_envfrom.html">xxfi_envfrom</A>), fail for this message. <BR>
 237          For a connection-oriented routine, fail for this connection; call <A HREF="xxfi_close.html">xxfi_close</A>. <BR>
 238          For a recipient-oriented routine, only fail for the current recipient; continue message processing.
 239      </TD>
 240   </TR>
 241
 242   <TR valign="top">
 243      <TD><A NAME="SMFIS_SKIP">SMFIS_SKIP</A></TD>
 244      <TD>Skip further callbacks of the same type in this transaction.
 245         Currently this return value is only allowed in
 246         <A HREF="xxfi_body.html">xxfi_body()</A>.
 247         It can be used if a milter has received sufficiently many
 248         body chunks to make a decision, but still wants to invoke
 249         message modification functions that are only allowed to be called from
 250         <A HREF="xxfi_eom.html">xxfi_eom()</A>.
 251         Note: the milter <EM>must</EM>
 252         <A HREF="xxfi_negotiate.html">negotiate</A>
 253         this behavior with the MTA, i.e., it must check whether
 254         the protocol action
 255         <A HREF="xxfi_negotiate.html#SMFIP_SKIP"><CODE>SMFIP_SKIP</CODE></A>
 256         is available and if so, the milter must request it.
 257      </TD>
 258   </TR>
 259
 260   <TR valign="top">
 261      <TD><A NAME="SMFIS_NOREPLY">SMFIS_NOREPLY</A></TD>
 262      <TD>Do not send a reply back to the MTA.
 263         The milter <EM>must</EM>
 264         <A HREF="xxfi_negotiate.html">negotiate</A>
 265         this behavior with the MTA, i.e., it must check whether
 266         the appropriate protocol action
 267         <A HREF="xxfi_negotiate.html#SMFIP_NR_"><CODE>SMFIP_NR_*</CODE></A>
 268         is available and if so, the milter must request it.
 269         If you set the
 270         <A HREF="xxfi_negotiate.html#SMFIP_NR_"><CODE>SMFIP_NR_*</CODE></A>
 271         protocol action for a callback, that callback <EM>must</EM>
 272         always reply with
 273         SMFIS_NOREPLY.
 274         Using any other reply code is a violation of the API.
 275         If in some cases your callback may return another value
 276         (e.g., due to some resource shortages), then you
 277         <EM>must not</EM> set
 278         <A HREF="xxfi_negotiate.html#SMFIP_NR_"><CODE>SMFIP_NR_*</CODE></A>
 279         and you must use
 280         SMFIS_CONTINUE as the default return code.
 281         (Alternatively you can try to delay reporting the problem to
 282         a later callback for which
 283         <A HREF="xxfi_negotiate.html#SMFIP_NR_"><CODE>SMFIP_NR_*</CODE></A>
 284         is not set.)
 285      </TD>
 286   </TR>
 287
 288 </TABLE>
 289
 290 <H2><A NAME="Miscellaneous">Miscellaneous</A></H2>
 291
 292 <P>
 293 <TABLE BORDER="1" CELLSPACING=0 CELLPADDING=2><TR BGCOLOR="#dddddd"><TH>Function</TH><TH>Description</TH></TR>
 294
 295 <TR><TD><A HREF="smfi_version.html">smfi_version</A></TD><TD>libmilter (runtime) version info</TD></TR>
 296
 297 <TR><TD><A HREF="smfi_setsymlist.html">smfi_setsymlist</A></TD><TD>
 298 Set the list of macros that the milter wants to receive from the MTA
 299 for a protocol stage.
 300 </TD></TR>
 301
 302 </TABLE>
 303
 304 <P>
 305 <TABLE BORDER="1" CELLSPACING=0 CELLPADDING=2><TR BGCOLOR="#dddddd"><TH>Constant</TH><TH>Description</TH></TR>
 306
 307 <TR><TD><A HREF="smfi_version.html">SMFI_VERSION</A></TD><TD>libmilter (compile time) version info</TD></TR>
 308
 309 </TABLE>
 310
 311
 312 <HR SIZE="1">
 313 <FONT SIZE="-1">
 314 Copyright (c) 2000, 2003, 2006, 2009 Proofpoint, Inc. and its suppliers.
 315 All rights reserved.
 316 <BR>
 317 By using this file, you agree to the terms and conditions set
 318 forth in the LICENSE.
 319 </FONT>
 320 </BODY>
 321 </HTML>