src/src/local_scan.c

   1 /*************************************************
   2 *     Exim - an Internet mail transport agent    *
   3 *************************************************/
   4
   5 /* Copyright (c) University of Cambridge 1995 - 2009 */
   6 /* Copyright (c) The Exim Maintainers 2021 */
   7 /* See the file NOTICE for conditions of use and distribution. */
   8 /* SPDX-License-Identifier: GPL-2.0-or-later */
   9
  10
  11 /******************************************************************************
  12 This file contains a template local_scan() function that just returns ACCEPT.
  13 If you want to implement your own version, you should copy this file to, say
  14 Local/local_scan.c, and edit the copy. To use your version instead of the
  15 default, you must set
  16
  17 HAVE_LOCAL_SCAN=yes
  18 LOCAL_SCAN_SOURCE=Local/local_scan.c
  19
  20 in your Local/Makefile. This makes it easy to copy your version for use with
  21 subsequent Exim releases.
  22
  23 For a full description of the API to this function, see the Exim specification.
  24 ******************************************************************************/
  25
  26
  27 /* This is the only Exim header that you should include. The effect of
  28 including any other Exim header is not defined, and may change from release to
  29 release. Use only the documented interface! */
  30
  31 #include "local_scan.h"
  32
  33
  34 /* This is a "do-nothing" version of a local_scan() function. The arguments
  35 are:
  36
  37   fd             The file descriptor of the open -D file, which contains the
  38                    body of the message. The file is open for reading and
  39                    writing, but modifying it is dangerous and not recommended.
  40
  41   return_text    A pointer to an unsigned char* variable which you can set in
  42                    order to return a text string. It is initialized to NULL.
  43
  44 The return values of this function are:
  45
  46   LOCAL_SCAN_ACCEPT
  47                  The message is to be accepted. The return_text argument is
  48                    saved in $local_scan_data.
  49
  50   LOCAL_SCAN_REJECT
  51                  The message is to be rejected. The returned text is used
  52                    in the rejection message.
  53
  54   LOCAL_SCAN_TEMPREJECT
  55                  This specifies a temporary rejection. The returned text
  56                    is used in the rejection message.
  57 */
  58
  59 int
  60 local_scan(int fd, uschar **return_text)
  61 {
  62 return LOCAL_SCAN_ACCEPT;
  63 }
  64
  65 /* End of local_scan.c */