[ezmlm] / ezmlm-gate.1

.TH ezmlm-gate 1
.SH NAME
ezmlm-gate \- Gate posts depending on message SENDER
.SH SYNOPSIS
.B ezmlm-gate [-cCmMpPrRsSvV] [-q file]
.I dir [moddir1] [moddir2 ...]
.SH DESCRIPTION
.B ezmlm-gate
checks if SENDER is in it least one of the subscriber lists
with base directory
.IR moddir1 ,
.IR moddir2 ,
etc.
If it is, the message is posted via
.B ezmlm-send 
to the list in
.IR dir .
If not, the message is sent for moderation via
.BR ezmlm-store .

The default is to send the message for moderation.
.SH OPTIONS
.TP
.B \-cCmMpPrRsS
Passed on to ezmlm-store(1) and ezmlm-send(1).
.TP
.B \-cCrR
Passed on to ezmlm-send(1).
.TP
.B \-q\fI file
Execute arbitration programs in
.IR file .
Lines in
.I file
are executed just like in regular
.IR .qmail
files with the difference that all lines are assumed to be program
names. See
.BR dot-qmail(5) .
Programs are executed by /bin/sh and the message is on stdin of the
executed program.
The leading ``|'' is optional. Comments and blank lines are allowed. If a
program exits 111, delivery is deferred. If it exits 99, the message is
sent to the list. If it exits 0, the next line is executed. If it exits
with any other exit code, the message is sent for moderation. Subscriber
status per
.IR moddir1 ,
.IR moddir2 ,
etc, is tested only if all the programs have been executed and the final
exit code is 0. Thus, programs can cause moderation (100), posting (99), or
defer the decision to the next program and ultimately to subscriber status.
.TP
.B \-v
Display version information.
.TP
.B \-V
Display version information.

.SH USAGE
.B ezmlm-gate
is best used if you want to restrict posts to a set of addresses using
SENDER checks. Obviously, this is not secure, but it 
can help quite a bit to keep
garbage off the list. For more secure setups, see
.BR ezmlm-store(1) .
For other arbitration such as SPAM protection, use the
.B \-q
option. For instance, invoking
.B ezmlm-reject(1)
here would cause failing messages to be sent for moderation rather that being
rejected.

Set up the list with a
.B ezmlm-gate
line in
.I dir\fB/editor
and touch
.IR dir\fB/modpost .
Add the moderator(s) (usually the list owner):

.EX
.B ezmlm-sub
.I dir\fB/mod
moderator@host
.EE

This will via
.B ezmlm-send
directly distribute
all posts from subscriber addresses and send out the rest for moderation
to the moderator(s) via
.BR ezmlm-store .
To test several subscriber databases, e.g. the list and the list-digest
subscribers, add the corresponding list directories to the
.B ezmlm-gate
command line.

This can be expanded to include users that post from addresses other than
the one they are subscribed as: just create another directory 'addl', and
a 'subscribers' subdirectory of it, and add 'addl' to the
.B ezmlm-gate
command line. Now just add all problem addresses to the 'addl' address
database using
.BR ezmlm-sub .
The entire point is that post from subscribers of any union
of list go through, posts from identified 'aliases' go through and all
others go for approval to the list owner. Thus, legitimate users are never
rejected and 'aliases' rapidly identified by the owner/moderator and
their handling automated one by one, by simply adding them to 'addl'.
.SH "SEE ALSO"
dot-qmail(5),
ezmlm(5),
ezmlm-issubn(1),
ezmlm-reject(1),
ezmlm-send(1),
ezmlm-store(1)
Commit	Line	Data
f8beb284 MW	1	.TH ezmlm-gate 1
	2	.SH NAME
	3	ezmlm-gate \- Gate posts depending on message SENDER
	4	.SH SYNOPSIS
	5	.B ezmlm-gate [-cCmMpPrRsSvV] [-q file]
	6	.I dir [moddir1] [moddir2 ...]
	7	.SH DESCRIPTION
	8	.B ezmlm-gate
	9	checks if SENDER is in it least one of the subscriber lists
	10	with base directory
	11	.IR moddir1 ,
	12	.IR moddir2 ,
	13	etc.
	14	If it is, the message is posted via
	15	.B ezmlm-send
	16	to the list in
	17	.IR dir .
	18	If not, the message is sent for moderation via
	19	.BR ezmlm-store .
	20
	21	The default is to send the message for moderation.
	22	.SH OPTIONS
	23	.TP
	24	.B \-cCmMpPrRsS
	25	Passed on to ezmlm-store(1) and ezmlm-send(1).
	26	.TP
	27	.B \-cCrR
	28	Passed on to ezmlm-send(1).
	29	.TP
	30	.B \-q\fI file
	31	Execute arbitration programs in
	32	.IR file .
	33	Lines in
	34	.I file
	35	are executed just like in regular
	36	.IR .qmail
	37	files with the difference that all lines are assumed to be program
	38	names. See
	39	.BR dot-qmail(5) .
	40	Programs are executed by /bin/sh and the message is on stdin of the
	41	executed program.
	42	The leading ``\|'' is optional. Comments and blank lines are allowed. If a
	43	program exits 111, delivery is deferred. If it exits 99, the message is
	44	sent to the list. If it exits 0, the next line is executed. If it exits
	45	with any other exit code, the message is sent for moderation. Subscriber
	46	status per
	47	.IR moddir1 ,
	48	.IR moddir2 ,
	49	etc, is tested only if all the programs have been executed and the final
	50	exit code is 0. Thus, programs can cause moderation (100), posting (99), or
	51	defer the decision to the next program and ultimately to subscriber status.
	52	.TP
	53	.B \-v
	54	Display version information.
	55	.TP
	56	.B \-V
	57	Display version information.
	58
	59	.SH USAGE
	60	.B ezmlm-gate
	61	is best used if you want to restrict posts to a set of addresses using
	62	SENDER checks. Obviously, this is not secure, but it
	63	can help quite a bit to keep
	64	garbage off the list. For more secure setups, see
65	.BR ezmlm-store(1) .
66	For other arbitration such as SPAM protection, use the
67	.B \-q
68	option. For instance, invoking
69	.B ezmlm-reject(1)
70	here would cause failing messages to be sent for moderation rather that being
71	rejected.
72
73	Set up the list with a
74	.B ezmlm-gate
75	line in
76	.I dir\fB/editor
77	and touch
78	.IR dir\fB/modpost .
79	Add the moderator(s) (usually the list owner):
80
81	.EX
82	.B ezmlm-sub
83	.I dir\fB/mod
84	moderator@host
85	.EE
86
87	This will via
88	.B ezmlm-send
89	directly distribute
90	all posts from subscriber addresses and send out the rest for moderation
91	to the moderator(s) via
92	.BR ezmlm-store .
93	To test several subscriber databases, e.g. the list and the list-digest
94	subscribers, add the corresponding list directories to the
95	.B ezmlm-gate
96	command line.
97
98	This can be expanded to include users that post from addresses other than
99	the one they are subscribed as: just create another directory 'addl', and
100	a 'subscribers' subdirectory of it, and add 'addl' to the
101	.B ezmlm-gate
102	command line. Now just add all problem addresses to the 'addl' address
103	database using
104	.BR ezmlm-sub .
105	The entire point is that post from subscribers of any union
106	of list go through, posts from identified 'aliases' go through and all
107	others go for approval to the list owner. Thus, legitimate users are never
108	rejected and 'aliases' rapidly identified by the owner/moderator and
109	their handling automated one by one, by simply adding them to 'addl'.
110	.SH "SEE ALSO"
111	dot-qmail(5),
112	ezmlm(5),
113	ezmlm-issubn(1),
114	ezmlm-reject(1),
115	ezmlm-send(1),
116	ezmlm-store(1)