mda: support --no-precheck option

[public-inbox.git] / Documentation / public-inbox-mda.pod

diff --git a/Documentation/public-inbox-mda.pod b/Documentation/public-inbox-mda.pod
index 3a43a1cefcaf5c5fc80035ef49e857c5ae90ab22..01bb84764bb1d379df14a9a82bbb9e7f2599e8e5 100644 (file)
--- a/Documentation/public-inbox-mda.pod
+++ b/Documentation/public-inbox-mda.pod
@@ -12,6 +12,35 @@ Mail Delivery Agent (MDA) for public-inbox installations.
 Each system user may have their own public-inbox instances.
 This may be invoked via L<procmail(1)> or similar tools.
 
 Each system user may have their own public-inbox instances.
 This may be invoked via L<procmail(1)> or similar tools.
 

+By default, it relies on L<spamc(1)> for filtering mail,
+but may be disabled via
+L<public-inbox-config(5)/publicinboxmda.spamcheck>
+
+=head1 OPTIONS
+
+=over 8
+
+=item --no-precheck
+
+By default, public-inbox-mda does some simple checks before
+invoking L<spamc(1)> since it is intended to receive mail before
+it goes to a mailing list.
+
+However, some users prefer to use public-inbox-mda to mirror
+mailing lists.  This option exists to support those users.
+
+Using this option, the following prechecks are disabled:
+
+  * multiple Message-IDs
+  * non-existent Message-IDs
+  * Message-IDs longer than 244 characters long
+  * From: header shorter than 3 characters
+  * Subject: header shorter than 2 characters
+  * unusable Date: headers
+  * inbox address specified in To: or Cc: header
+
+=back
+

 =head1 ENVIRONMENT
 
 =over 8
 =head1 ENVIRONMENT
 
 =over 8


@@ -21,6 +50,9 @@ This may be invoked via L<procmail(1)> or similar tools.
 The original recipient email address, set by the MTA.  Postfix
 sets it by default, untested on other MTAs.
 
 The original recipient email address, set by the MTA.  Postfix
 sets it by default, untested on other MTAs.
 

+This does not have to be set if relying on C<publicinbox.$NAME.listid>
+directives configured in L<public-inbox-config(5)>.
+

 =item PI_CONFIG
 
 Per-user config file parseable by L<git-config(1)>.
 =item PI_CONFIG
 
 Per-user config file parseable by L<git-config(1)>.


@@ -46,10 +78,10 @@ and L<http://hjrcffqmbrq6wope.onion/meta/>
 
 =head1 COPYRIGHT
 
 
 =head1 COPYRIGHT
 

-Copyright 2013-2016 all contributors L<mailto:meta@public-inbox.org>
+Copyright 2013-2019 all contributors L<mailto:meta@public-inbox.org>

 
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 
 =head1 SEE ALSO
 
 
 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
 
 =head1 SEE ALSO
 

-L<git(1)>, L<git-config(1)>, L<ssoma_repository(5)>
+L<git(1)>, L<git-config(1)>, L<public-inbox-v1-format(5)>