| 1 | .TH ezmlm-clean 1 |
| 2 | .SH NAME |
| 3 | ezmlm-clean \- clean moderation directory |
| 4 | .SH SYNOPSIS |
| 5 | .B ezmlm-clean [mMrRvV] |
| 6 | .I dir |
| 7 | .SH DESCRIPTION |
| 8 | If |
| 9 | .I dir\fB/modpost |
| 10 | exists, |
| 11 | .B ezmlm-clean |
| 12 | sends out messages for timed-out posts in the moderation directory |
| 13 | and removes stubs for rejected and accepted posts |
| 14 | for the mailing list stored in |
| 15 | .IR dir . |
| 16 | If |
| 17 | .I dir\fB/modpost |
| 18 | does not exist, |
| 19 | .B ezmlm-clean |
| 20 | does nothing and exits. |
| 21 | |
| 22 | .B ezmlm-clean |
| 23 | reads |
| 24 | .I dir\fB/modtime |
| 25 | and extracts a time-out ``time'' in hours from it. If ``time'' is 0 or |
| 26 | .I dir\fB/modtime |
| 27 | is empty or doesn't exist, |
| 28 | a default of 120 h is used. If a time is given, it is limited to |
| 29 | the range 24 h to 240 h. |
| 30 | |
| 31 | .B ezmlm-clean |
| 32 | then looks through |
| 33 | .I dir\fB/mod/accepted/ |
| 34 | and |
| 35 | .I dir\fB/mod/rejected/ |
| 36 | and removes message stubs older than ``time''. ``Time'' is |
| 37 | a minimum retention time. Since the files are processed only |
| 38 | when |
| 39 | .B ezmlm-clean |
| 40 | is run, the delay before a message is timed-out may |
| 41 | be substantially longer if the list does not receive many messages. |
| 42 | |
| 43 | Message age |
| 44 | determined by the time parsed |
| 45 | .I from the file name, |
| 46 | not from the creation time. |
| 47 | Thus, there is no good way to extend the life of |
| 48 | the file by e.g. touching it. Also, files in these directories are not |
| 49 | checked for the proper format. Thus, most non-message files in these |
| 50 | directories will be deleted the first time |
| 51 | .B ezmlm-clean |
| 52 | is run. |
| 53 | |
| 54 | For messages in |
| 55 | .I dir\fB/mod/pending/ |
| 56 | no action is taken on read-only files. Messages without the owner execute |
| 57 | bit set are silently removed, as they are the result of incomplete |
| 58 | .B ezmlm-store(1) |
| 59 | executions. For other messages, a notification of the time out is sent |
| 60 | to the sender, before the file is removed. |
| 61 | |
| 62 | .B ezmlm-clean |
| 63 | logs errors to the mail log. |
| 64 | Re-delivery should be avoided by suffixing any |
| 65 | .I \.qmail |
| 66 | line invoking |
| 67 | .B ezmlm-clean |
| 68 | with '|| exit 0'. |
| 69 | .SH OPTIONS |
| 70 | .TP |
| 71 | .B \-m |
| 72 | (Default.) |
| 73 | The timed-out post is sent as a MIME enclosure. |
| 74 | .TP |
| 75 | .B \-M |
| 76 | The timed-out post is appended to the message. |
| 77 | .TP |
| 78 | .B \-r |
| 79 | (Default.) |
| 80 | The timed-out post is returned to sender. |
| 81 | .TP |
| 82 | .B \-R |
| 83 | The timed-out post is discarded without sender notification. |
| 84 | .B Note: |
| 85 | .B ezmlm-clean |
| 86 | is normally run from both |
| 87 | .I dir\fB/editor |
| 88 | and |
| 89 | .IR dir\fB/moderator . |
| 90 | To suppress sender notification, the switch needs to be specified |
| 91 | for all invocations of |
| 92 | .BR ezmlm-clean . |
| 93 | .TP |
| 94 | .B \-v |
| 95 | Display |
| 96 | .B ezmlm-clean |
| 97 | version information. |
| 98 | .TP |
| 99 | .B \-V |
| 100 | Display |
| 101 | .B ezmlm-clean |
| 102 | version information. |
| 103 | .SH "CHARACTER SETS" |
| 104 | If |
| 105 | .I dir\fB/charset |
| 106 | exists, |
| 107 | .B ezmlm-clean |
| 108 | will use the character set listed for all messages. Otherwise, the |
| 109 | default ``us-ascii'' will be used. The character set can be suffixed |
| 110 | by ``:'' followed by a code. If the code is ``Q'', outgoing messages are |
| 111 | sent as ``Quoted-Printable'', if it is ``B'' they are sent ``base64'' encoded. |
| 112 | Otherwise, text is sent as is. |
| 113 | .SH "SEE ALSO" |
| 114 | ezmlm-make(1), |
| 115 | ezmlm-moderate(1), |
| 116 | ezmlm-store(1), |
| 117 | ezmlm(5) |