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

   1 .TH ezmlm-manage 1
   2 .SH NAME
   3 ezmlm-manage \- automatically manage a mailing list
   4 .SH SYNOPSIS
   5 .B ezmlm-manage
   6 .I dir
   7 .SH DESCRIPTION
   8 .B ezmlm-manage
   9 handles administrative requests for the mailing list
  10 stored in
  11 .IR dir .
  12
  13 .B ezmlm-manage
  14 is normally invoked from a
  15 .B .qmail
  16 file.
  17 It reads a mail message from its standard input,
  18 and a mail envelope from the
  19 .BR SENDER ,
  20 .BR LOCAL ,
  21 and
  22 .BR HOST
  23 environment variables.
  24
  25 .B ezmlm-manage
  26 expects
  27 .B LOCAL
  28 to be of the form
  29 .IR list\fB-\fIaction\fB-\fIbox\fB=\fIdomain .
  30 Here
  31 .I list
  32 is the first line of
  33 .IR dir\fB/inlocal ,
  34 .I action
  35 is a request,
  36 and
  37 .I box\fB@\fIdomain
  38 is the target of the request.
  39 .B ezmlm-manage
  40 sends a response to the target.
  41 It attaches the original message to the end of its response.
  42
  43 .B LOCAL
  44 may instead be of the form
  45 .IR list\fB-\fIaction .
  46 Then the envelope sender
  47 is used as the target.
  48
  49 .B ezmlm-manage
  50 expects
  51 .B HOST
  52 to match the first line of
  53 .IR dir\fB/inhost .
  54
  55 .B ezmlm-manage
  56 copies
  57 .I dir\fB/mailinglist
  58 into a
  59 .B Mailing-List
  60 field in its response.
  61 If the incoming message has a
  62 .B Mailing-List
  63 field,
  64 .B ezmlm-manage
  65 refuses to respond.
  66 .B ezmlm-manage
  67 also refuses to respond to bounce messages.
  68 .SH SUBSCRIPTIONS
  69 If
  70 .I action
  71 is
  72 .BR sc.\fIcookie ,
  73 where
  74 .I cookie
  75 is an appropriate code
  76 (depending on the target, the approximate time, and other factors),
  77 .B ezmlm-manage
  78 adds the target to the mailing list.
  79
  80 If
  81 .I action
  82 is
  83 .BR subscribe ,
  84 .B ezmlm-manage
  85 does not subscribe the target,
  86 but it identifies the right
  87 .BR sc.\fIcookie
  88 address in its response.
  89
  90 This confirmation mechanism
  91 (1) verifies that the target is reachable
  92 and
  93 (2) protects the target against forged subscription requests.
  94
  95 Actions of
  96 .B uc.\fIcookie
  97 and
  98 .B unsubscribe
  99 are used in the same way to delete the target from the mailing list.
 100
 101 If
 102 .I dir\fB/public
 103 does not exist,
 104 .B ezmlm-manage
 105 rejects all subscription and unsubscription attempts.
 106 .SH "ARCHIVE RETRIEVALS"
 107 If
 108 .I action
 109 is
 110 .BR get.\fInum ,
 111 .B ezmlm-manage
 112 sends back message
 113 .I num
 114 from
 115 .IR dir\fB/archive .
 116
 117 If
 118 .I dir\fB/public
 119 does not exist,
 120 .B ezmlm-manage
 121 rejects all archive retrieval attempts.
 122 .SH "SEE ALSO"
 123 ezmlm-make(1),
 124 ezmlm-return(1),
 125 ezmlm-send(1),
 126 ezmlm-sub(1),
 127 ezmlm-unsub(1),
 128 ezmlm(5),
 129 qmail-command(8)