external/ibm-public/postfix/dist/src/global/cleanup_user.h

   1 /*      $NetBSD$        */
   2
   3 #ifndef _CLEANUP_USER_H_INCLUDED_
   4 #define _CLEANUP_USER_H_INCLUDED_
   5
   6 /*++
   7 /* NAME
   8 /*      cleanup_user 3h
   9 /* SUMMARY
  10 /*      cleanup user interface codes
  11 /* SYNOPSIS
  12 /*      #include <cleanup_user.h>
  13 /* DESCRIPTION
  14 /* .nf
  15
  16  /*
  17   * Client processing options. Flags 16- are reserved for cleanup.h.
  18   */
  19 #define CLEANUP_FLAG_NONE       0       /* No special features */
  20 #define CLEANUP_FLAG_BOUNCE     (1<<0)  /* Bounce bad messages */
  21 #define CLEANUP_FLAG_FILTER     (1<<1)  /* Enable header/body checks */
  22 #define CLEANUP_FLAG_HOLD       (1<<2)  /* Place message on hold */
  23 #define CLEANUP_FLAG_DISCARD    (1<<3)  /* Discard message silently */
  24 #define CLEANUP_FLAG_BCC_OK     (1<<4)  /* Ok to add auto-BCC addresses */
  25 #define CLEANUP_FLAG_MAP_OK     (1<<5)  /* Ok to map addresses */
  26 #define CLEANUP_FLAG_MILTER     (1<<6)  /* Enable Milter applications */
  27 #define CLEANUP_FLAG_SMTP_REPLY (1<<7)  /* Enable SMTP reply */
  28
  29 #define CLEANUP_FLAG_FILTER_ALL (CLEANUP_FLAG_FILTER | CLEANUP_FLAG_MILTER)
  30  /*
  31   * These are normally set when receiving mail from outside.
  32   */
  33 #define CLEANUP_FLAG_MASK_EXTERNAL \
  34         (CLEANUP_FLAG_FILTER_ALL | CLEANUP_FLAG_BCC_OK | CLEANUP_FLAG_MAP_OK)
  35
  36  /*
  37   * These are normally set when generating notices or when forwarding mail
  38   * internally.
  39   */
  40 #define CLEANUP_FLAG_MASK_INTERNAL CLEANUP_FLAG_MAP_OK
  41
  42  /*
  43   * These are set on the fly while processing SMTP envelopes or message
  44   * content.
  45   */
  46 #define CLEANUP_FLAG_MASK_EXTRA \
  47         (CLEANUP_FLAG_HOLD | CLEANUP_FLAG_DISCARD)
  48
  49  /*
  50   * Diagnostics.
  51   *
  52   * CLEANUP_STAT_CONT and CLEANUP_STAT_DEFER both update the reason attribute,
  53   * but CLEANUP_STAT_DEFER takes precedence. It terminates queue record
  54   * processing, and prevents bounces from being sent.
  55   */
  56 #define CLEANUP_STAT_OK         0       /* Success. */
  57 #define CLEANUP_STAT_BAD        (1<<0)  /* Internal protocol error */
  58 #define CLEANUP_STAT_WRITE      (1<<1)  /* Error writing message file */
  59 #define CLEANUP_STAT_SIZE       (1<<2)  /* Message file too big */
  60 #define CLEANUP_STAT_CONT       (1<<3)  /* Message content rejected */
  61 #define CLEANUP_STAT_HOPS       (1<<4)  /* Too many hops */
  62 #define CLEANUP_STAT_RCPT       (1<<6)  /* No recipients found */
  63 #define CLEANUP_STAT_PROXY      (1<<7)  /* Proxy reject */
  64 #define CLEANUP_STAT_DEFER      (1<<8)  /* Temporary reject */
  65
  66  /*
  67   * These are set when we can't bounce even if we were asked to.
  68   */
  69 #define CLEANUP_STAT_MASK_CANT_BOUNCE \
  70         (CLEANUP_STAT_BAD | CLEANUP_STAT_WRITE | CLEANUP_STAT_DEFER)
  71
  72  /*
  73   * These are set when we can't examine every record of a message.
  74   */
  75 #define CLEANUP_STAT_MASK_INCOMPLETE \
  76         (CLEANUP_STAT_BAD | CLEANUP_STAT_WRITE | CLEANUP_STAT_SIZE \
  77             | CLEANUP_STAT_DEFER)
  78
  79  /*
  80   * Mapping from status code to DSN detail and free text.
  81   */
  82 typedef struct {
  83     const unsigned status;              /* CLEANUP_STAT_MUMBLE */
  84     const int smtp;                     /* RFC 821 */
  85     const char *dsn;                    /* RFC 3463 */
  86     const char *text;                   /* free text */
  87 } CLEANUP_STAT_DETAIL;
  88
  89 extern const char *cleanup_strerror(unsigned);
  90 extern const CLEANUP_STAT_DETAIL *cleanup_stat_detail(unsigned);
  91 extern const char *cleanup_strflags(unsigned);
  92
  93 /* LICENSE
  94 /* .ad
  95 /* .fi
  96 /*      The Secure Mailer license must be distributed with this software.
  97 /* AUTHOR(S)
  98 /*      Wietse Venema
  99 /*      IBM T.J. Watson Research
 100 /*      P.O. Box 704
 101 /*      Yorktown Heights, NY 10598, USA
 102 /*--*/
 103
 104 #endif