mdw@git.distorted.org.uk Git - ezmlm/blob - ezmlm-store.1

   1 .TH ezmlm-store 1
   2 .SH NAME
   3 ezmlm-store \- store messages posted to a moderated lists and send
   4 moderation requests to the moderator(s).
   5 .SH SYNOPSIS
   6 .B ezmlm-store [-bBcCmMpPrRsSvV]
   7 .I dir
   8 .SH DESCRIPTION
   9 .B ezmlm-store
  10 reads a mail message and
  11 stores it in
  12 .I dir\fB/mod/pending/.
  13 .B ezmlm-store
  14 also sends a moderation request with a copy of the message to the list of
  15 moderators stored in
  16 .I dir\fB/mod/subscribers/.
  17 If
  18 .I dir\fB/modpost
  19 contains a directory name,
  20 .IR moddir ,
  21 with a leading forward slash, the moderator list in
  22 .I /moddir/subscribers/
  23 is used instead. This allows separate sets of moderators for
  24 subscription and message moderation, as
  25 well as the use of the same moderator list for several
  26 .B ezmlm
  27 mailing lists, owned by the same user. If the
  28 .B \-s
  29 switch is used, the moderators are divided into two sets. Those pointed to by
  30 .I dir\fB/modpost
  31 which will receive confirmation requests for posts with their SENDER address,
  32 and those stored with the base directory
  33 .I dir\fB/mod/
  34 which will receive moderation requests for messages posted from SENDERs not
  35 part of the first group. This can be used to have a set of trusted
  36 users (``moderating'' themselves to thwart SENDER faking), and a set of more
  37 traditional moderators, which receive approval requests for other posts.
  38
  39 .B Note:
  40 The contents of
  41 .I dir\fB/modpost
  42 do not affect the location of the message moderation queue.
  43
  44 If SENDER is a moderator, the request is sent
  45 to that moderator only.
  46
  47 The moderation request includes cookies for message rejection and acceptance.
  48 The moderator can take either action by replying to the appropriate address.
  49 For moderator convenience, the
  50 .I accept
  51 address is given in
  52 the ``Reply-To:'' header, and the
  53 .I reject
  54 address in the ``From:'' header.
  55
  56 If the list is set up with remote administration and the sender is not a
  57 moderator, the ``Cc:'' header will contain a confirmation address to add
  58 the sender to the ``allow'' database. This allows the moderator to both
  59 approve the post and add the sender to the list of accepted posters by
  60 replying to ``all''.
  61
  62 The (default) subject of all message moderation requests is
  63 .B MODERATE for\fI listname@host.
  64
  65 Once the request has been successfully sent to the moderators,
  66 .B ezmlm-store
  67 sets the owner-execute bit of the message in
  68 .I dir\fB/mod/pending/.
  69 Messages without this bit set are the result of incomplete executions of
  70 .B ezmlm-store
  71 and are ignored.
  72
  73 At the beginning of the message,
  74 .B ezmlm-store
  75 prints a new
  76 .B Mailing-List
  77 field with the contents of
  78 .IR dir\fB/mailinglist .
  79 It rejects the message if there is already a
  80 .B Mailing-List
  81 field.
  82
  83 .B ezmlm-store
  84 does not distribute bounce messages:
  85 if the environment variable
  86 .B SENDER
  87 is set, and is either empty or
  88 .BR #@[] ,
  89 .B ezmlm-store
  90 rejects the message.
  91 .SH OPTIONS
  92 .TP
  93 .B \-b
  94 (Default.)
  95 With the moderation request,
  96 send both headers and body of the message to be moderated.
  97 .TP
  98 .B \-B
  99 With the moderation request,
 100 send header, but not body of the message to be moderated.
 101 This may be useful if moderation is used to allow one or a few poorly
 102 connected addresses to post, and posts are very large (e.g. when the list
 103 is used as a distribution channel of e.g. catalogs).
 104 .TP
 105 .B \-cCrR
 106 Passed on to
 107 .B ezmlm-send(1)
 108 in case this program is executed. This happens only if
 109 .I dir\fB/modpost
 110 does not exist.
 111 .TP
 112 .B \-m
 113 (Default.)
 114 The post is sent as a MIME enclosure.
 115 .TP
 116 .B \-M
 117 The post is appended to the message.
 118 .TP
 119 .B \-s
 120 The contents of
 121 .I dir\fB/modpost
 122 with the default
 123 .I dir\fB/mod/
 124 are used as the base directory for self-approving users, whereas
 125 .I dir\fB/mod/
 126 is used as the base directory
 127 for the moderators to whom approval requests for other
 128 posts are sent.
 129 .TP
 130 .B \-S
 131 (Default.)
 132 The contents of
 133 .I dir\fB/modpost
 134 with the default
 135 .I dir\fB/mod/
 136 are used as the base directory
 137 for the moderators for all moderator functions.
 138 .TP
 139 .B \-p
 140 (Default.)
 141 Anyone can post. Posts that are not from a moderator are sent out to
 142 all moderators for approval. Posts that are from a moderator are
 143 sent only to that moderator.
 144 .TP
 145 .B \-P
 146 Only moderators can post. Those posts are sent to the posting moderator
 147 for approval. Posts from other addresses are bounced. This can be used
 148 to relatively securely restrict posts to messages originating from
 149 a given set of addresses.
 150 .TP
 151 .B \-v
 152 Display
 153 .B ezmlm-manage
 154 version information.
 155 .TP
 156 .B \-V
 157 Display
 158 .B ezmlm-manage
 159 version information.
 160 .SH USAGE
 161 First of all, remember that
 162 .B ezmlm-store
 163 will simply execute
 164 .B ezmlm-send(1)
 165 unless
 166 .I dir\fB/modpost
 167 exists.
 168 For the switches, use
 169 .B \-P
 170 for lists where only moderators can post securely, i.e. they are
 171 asked to approve their own posts after posting,
 172 whereas other SENDERs are rejected. For
 173 low-security more convenient versions of this type of restriction, see
 174 .BR ezmlm-gate(1) .
 175
 176 Normally (no switches),
 177 posts from moderators are sent for approval only to the sending
 178 moderator, whereas posts from other addresses are sent to all moderators.
 179 Thus, you can set up an announcement list by adding all potential posters
 180 as moderators. However, you may also want to allow others to post, as
 181 long as the posts are approved. This would be default
 182 .B ezmlm-store
 183 function.
 184
 185 To make the set of ``approved posters'' who approve their own posts, different
 186 from the set of addresses that approve posts from other users, use the
 187 .B \-s
 188 switch. Add a directory name to
 189 .IR dir\fB/modpost .
 190 This directory is the base directory of the ``approved posters''
 191 database. Add the moderators for other posts to
 192 .I dir\fB/mod/
 193 using
 194 .BR ezmlm-sub(1) .
 195 .SH "CHARACTER SETS"
 196 If
 197 .I dir\fB/charset
 198 exists,
 199 .B ezmlm-store
 200 will use the character set listed for all messages. Otherwise, the
 201 default ``us-ascii'' will be used. The character set can be suffixed
 202 by ``:'' followed by a code. If the code is ``Q'', outgoing messages are
 203 sent as ``Quoted-Printable'', if it is '`B'' they are sent ``base64'' encoded.
 204 Otherwise, text is sent as is.
 205 .SH "SEE ALSO"
 206 ezmlm-clean(1),
 207 ezmlm-manage(1),
 208 ezmlm-make(1),
 209 ezmlm-moderate(1),
 210 ezmlm(5)