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 This does not have to be set if relying on C<publicinbox.$NAME.listid>
  29 directives configured in L<public-inbox-config(5)>.
  30
  31 =item PI_CONFIG
  32
  33 Per-user config file parseable by L<git-config(1)>.
  34 See L<public-inbox-config(5)>.
  35
  36 Default: ~/.public-inbox/config
  37
  38 =item PI_EMERGENCY
  39
  40 emergency Maildir destination.
  41
  42 Default: ~/.public-inbox/emergency/
  43
  44 =back
  45
  46
  47 =head1 CONTACT
  48
  49 Feedback welcome via plain-text mail to L<mailto:meta@public-inbox.org>
  50
  51 The mail archives are hosted at L<https://public-inbox.org/meta/>
  52 and L<http://hjrcffqmbrq6wope.onion/meta/>
  53
  54 =head1 COPYRIGHT
  55
  56 Copyright 2013-2019 all contributors L<mailto:meta@public-inbox.org>
  57
  58 License: AGPL-3.0+ L<https://www.gnu.org/licenses/agpl-3.0.txt>
  59
  60 =head1 SEE ALSO
  61
  62 L<git(1)>, L<git-config(1)>, L<public-inbox-v1-format(5)>