doc/pod/innmail.pod

   1 =head1 NAME
   2
   3 innmail - Simple mail-sending program
   4
   5 =head1 SYNOPSIS
   6
   7 B<innmail> [B<-h>] [B<-s> I<subject>] I<address> [I<address> ...]
   8
   9 =head1 DESCRIPTION
  10
  11 B<innmail> is a Perl script intended to provide the non-interactive
  12 mail-sending functionality of mail(1) while avoiding nasty security
  13 problems.  It takes the body of a mail message on standard input and sends
  14 it to the specified addresses by invoking the value of I<mta> in
  15 F<inn.conf>.
  16
  17 At least one address (formatted for the MTA specified in F<inn.conf>, if it
  18 matters) is required.  B<innmail> will sanitize the addresses so that they
  19 contain only alphanumerics and the symbols C<@>, C<.>, C<->, C<+>, C<_>,
  20 and C<%>.
  21
  22 B<innmail> was written to be suitable for the I<mailcmd> setting in
  23 F<inn.conf>.
  24
  25 =head1 OPTIONS
  26
  27 =over 4
  28
  29 =item B<-h>
  30
  31 Gives usage information.
  32
  33 =item B<-s> I<subject>
  34
  35 Sets the Subject: header of the message.  A warning is issued if this
  36 option is omitted.
  37
  38 =back
  39
  40 =head1 EXAMPLES
  41
  42 This sends a one-line message to the local user C<joe>:
  43
  44     echo "A one-line message." | innmail -s "Simple message" joe
  45
  46 B<innmail> by default is used by INN for sending nightly reports and
  47 control message reports.
  48
  49 =head1 BUGS
  50
  51 B<innmail> fails on addresses that begin with C<->, although one might
  52 hope that the news server will not need to contact any such addresses.
  53
  54 There are many "correct" addresses that will be silently modified by the
  55 sanitization process.  A news administrator should be careful to use
  56 particularly sane addresses if they may be passed to B<innmail>.
  57
  58 =head1 HISTORY
  59
  60 B<innmail> was written by James Brister <brister@vix.com> for
  61 InterNetNews.  This manual page was originally written by Jeffrey
  62 M. Vinocur.
  63
  64 =head1 SEE ALSO
  65
  66 inn.conf(5), mail(1).
  67
  68 =cut