]> Sergey Matveev's repositories - public-inbox.git/blob - Documentation/public-inbox-mda.pod
wwwtext: support $INBOX_URL/_/text/config/raw
[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 ENVIRONMENT
20
21 =over 8
22
23 =item ORIGINAL_RECIPIENT
24
25 The original recipient email address, set by the MTA.  Postfix
26 sets it by default, untested on other MTAs.
27
28 =item PI_CONFIG
29
30 Per-user config file parseable by L<git-config(1)>.
31 See L<public-inbox-config(5)>.
32
33 Default: ~/.public-inbox/config
34
35 =item PI_EMERGENCY
36
37 emergency Maildir destination.
38
39 Default: ~/.public-inbox/emergency/
40
41 =back
42
43
44 =head1 CONTACT
45
46 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
47
48 The mail archives are hosted at L<https://public-inbox.org/meta/>
49 and L<http://hjrcffqmbrq6wope.onion/meta/>
50
51 =head1 COPYRIGHT
52
53 Copyright 2013-2019 all contributors L<mailto:meta@public-inbox.org>
54
55 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
56
57 =head1 SEE ALSO
58
59 L<git(1)>, L<git-config(1)>, L<public-inbox-v1-format(5)>