]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/public-inbox-mda.pod
v2writable: compatibility with SWIG Xapian binding
[public-inbox.git] / Documentation / public-inbox-mda.pod
1 =head1 NAME
2
3 public-inbox-mda - mail delivery agent for public-inbox
4
5 =head1 SYNOPSIS
6
7 B<public-inbox-mda> E<lt>MESSAGE
8
9 =head1 DESCRIPTION
10
11 Mail Delivery Agent (MDA) for public-inbox installations.
12 Each system user may have their own public-inbox instances.
13 This may be invoked via L<procmail(1)> or similar tools.
14
15 By default, it relies on L<spamc(1)> for filtering mail,
16 but may be disabled via
17 L<public-inbox-config(5)/publicinboxmda.spamcheck>
18
19 =head1 OPTIONS
20
21 =over 8
22
23 =item --no-precheck
24
25 By default, public-inbox-mda does some simple checks before
26 invoking L<spamc(1)> since it is intended to receive mail before
27 it goes to a mailing list.
28
29 However, some users prefer to use public-inbox-mda to mirror
30 mailing lists.  This option exists to support those users.
31
32 Using this option, the following prechecks are disabled:
33
34   * multiple Message-IDs
35   * non-existent Message-IDs
36   * Message-IDs longer than 244 characters long
37   * From: header shorter than 3 characters
38   * Subject: header shorter than 2 characters
39   * unusable Date: headers
40   * inbox address specified in To: or Cc: header
41
42 =back
43
44 =head1 ENVIRONMENT
45
46 =over 8
47
48 =item ORIGINAL_RECIPIENT
49
50 The original recipient email address, set by the MTA.  Postfix
51 sets it by default, untested on other MTAs.
52
53 This does not have to be set if relying on C<publicinbox.$NAME.listid>
54 directives configured in L<public-inbox-config(5)>.
55
56 =item PI_CONFIG
57
58 Per-user config file parseable by L<git-config(1)>.
59 See L<public-inbox-config(5)>.
60
61 Default: ~/.public-inbox/config
62
63 =item PI_EMERGENCY
64
65 emergency Maildir destination.
66
67 Default: ~/.public-inbox/emergency/
68
69 =back
70
71
72 =head1 CONTACT
73
74 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
75
76 The mail archives are hosted at L<https://public-inbox.org/meta/>
77 and L<http://hjrcffqmbrq6wope.onion/meta/>
78
79 =head1 COPYRIGHT
80
81 Copyright 2013-2020 all contributors L<mailto:meta@public-inbox.org>
82
83 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
84
85 =head1 SEE ALSO
86
87 L<git(1)>, L<git-config(1)>, L<public-inbox-v1-format(5)>