1 .TH ENEMIES\-OF\-CARLOTTA 1
3 enemies\-of\-carlotta \- a simple mailing list manager
5 .B enemies\-of\-carlotta
6 .IR "" [ options "] [" addresses ]
8 .B enemies\-of\-carlotta
9 is a simple mailing list manager.
10 If you don't know what a mailing list manager is, you should learn
11 what they are before trying to use one.
12 A manual page is unfortunately too short to explain it.
14 Enemies of Carlotta keeps all data about the lists in the
15 .I ~/.enemies\-of\-carlotta
17 It will be created automatically when you create your first list.
18 You need to arrange manually for the mails to be processed by the
20 The details differ from mail system to another.
21 For QMail and Postfix, see below.
23 Each list has one or more owners, who also moderate subscriptions or
24 moderate some or all postings.
25 On completely unmoderated lists the list owners are responsible for
26 answering questions about the list.
27 On completely moderated lists, they have to approve each message before
28 it is sent to the list.
31 messages from subscribers are sent automatically to the list, and the
32 moderators have to approve the rest.
35 .BR \-\-name= foo@example.com
36 Specify the list the command is to operate on.
37 Most of the remaining options require you to set the list name with this
39 With the \-\-edit, \-\-subscribe, \-\-unsubscribe, and \-\-list options,
40 the name can be abbreviated to by leaving out the @ sign and domain.
44 You must specify at least one owner with
47 .BI \-\-owner= address
48 Specify a list owner when creating or editing a list.
50 .BI \-\-moderator= address
51 Specificy a list moderator when creating or editing a list.
53 .BI \-\-language= language\-code
54 Set the language code used for looking up template files.
55 The code should be empty (the default, meaning English), or a two\-letter
61 .B \-\-cleaning\-woman
62 Deal with bouncing addresses and do other cleanup.
64 .B "enemies\-of\-carlotta \-\-cleaning\-woman"
65 periodically, such as once per hour.
66 It will clean up all your lists.
72 Modify the list configuration.
74 .BI \-\-subscription= type
75 When creating a list, set its subscription mode to
85 When creating a list, set its posting mode to
89 (only subscribers can post, mails from others need to be moderated),
92 (all mails are moderated).
98 .BI \-\-archived= yes\-or\-no
99 Should list messages be archived to the
101 directory in the list directory under the
102 .B "~/.enemies\-of\-carlotta"
109 .BI \-\-mail\-on\-subscription\-changes= yes\-or\-no
110 Should the list owners be notified when someone subscribes to or
111 unsubscribes from the list?
118 .BI \-\-mail\-on\-forced\-unsubscription= yes\-or\-no
119 Should list owners be notified when someone is forcibly dropped from
120 the list due to too much bouncing?
127 .BI \-\-ignore\-bounce= yes\-or\-no
128 Should bounces be ignored?
136 List the subscribers of a list.
139 Add subscribers to a list.
140 The non\-option arguments are the addresses to be subscribed.
141 Note that addresses added this way won't be sent confirmation requests.
144 Remove subscribers from a list.
145 The non\-option arguments are the addresses to be unsubscribed.
146 Note that addresses removed this way won't be sent confirmation requests.
149 Deal with an incoming message in the standard input.
150 The SMTP envelope sender address must be given in the
152 environment variable, and the SMTP envelope recipient address in the
154 environment variable.
155 (QMail and Postfix do this automatically.)
157 .BI \-\-skip\-prefix= string
158 Before analyzing the recipient address to see which list it refers, remove
161 This helps deal with QMail and Postfix virtual domains, see above.
163 .BI \-\-domain= domain.name
164 Before analyzing the recipient address to see which list it refers, replace
165 the domain name part with
167 This helps deal with Postfix virtual domains.
170 Does the address specified with
172 refer to a valid list?
173 This sets the exit code to zero (success) if it does, or one (failure)
176 .BI \-\-sendmail= pathname
180 .B /usr/sbin/sendmail
181 for sending mail via a command line interface.
182 Note that the command must obey the sendmail command line interface.
184 .BI \-\-smtp\-server= hostname
185 Send mail using the SMTP server at
188 The server must be configured to allow the list host to relay mail
190 Note that a command line interface is used by default;
191 SMTP sending is used only if you use this option.
193 .BI \-\-qmqp\-server= hostname
194 Send mail using the QMQP server at
197 The server must be configured to allow the list host to relay mail
199 Note that a command line interface is used by default;
200 QMQP sending is used only if you use this option.
203 Force an incoming message to be moderated, even if it is going to a list
204 where posting is free.
205 This can be used for spam filtering:
206 you pipe incoming messages through whatever spam filter you choose to use
207 and if the mssage looks like spam, you ask it to be moderated by a human.
210 Force an incoming message to be posted, even if it is going to a list
211 where posting is moderated.
212 This can be used when there is an external check for whether a mail
213 is acceptable to the list, e.g., by checking digital signatures.
216 By default, debugging log messages are sent to the standard error output
218 With this option, they aren't.
220 .BI \-\-sender= foo@example.com
222 .BI \-\-recipient= foo@example.com
223 These two options are used with
227 to override the environment variables
234 Get the values of one or more configuration variables.
235 The name of the variables are given on the command line after the options.
236 Each value is printed on a separate line.
239 Set the values of one or more configuration variables.
240 The names and values are given on the command line after the options
241 and separated by an equals sign ("=").
242 For example, the following would set the language of a list to Finnish:
243 .B "enemies\-of\-carlotta \-\-name=foo@bar \-\-set language=fi"
246 Print out the version of the program.
249 List the lists enemies\-of\-carlotta knows about.
251 Each list is represented by a directory, named after the list, in
252 .IR ~/.enemies\-of\-carlotta .
253 That directory contains several files and directories, described below.
254 In general, it is not necessary to touch these at all.
255 However, some esoteric configuration can only be done by hand editing
256 of the list configuration file.
259 The list configuration file.
260 Contents are described below.
264 Each line contains a subscriber group, with the first five space
265 delimited fields being group identifier, status, timestamp for when
266 the group was created, timestamp for the bounce that made it switch
267 from status 'ok' to 'bounced', and the bounce identifier.
273 Bounce messages groups not in state 'ok'.
276 These headers are added to the mails sent to the list.
277 They are copied to the beginning of the existing headers exactly as they
278 are in the file, after list headers ("List\-ID" and such) have been added
279 and those mentioned in
280 .B headers\-to\-remove
283 .B headers\-to\-remove
284 These headers are removed from mails sent to the list.
287 Messages waiting for moderator approval.
290 Subscription and unsubscription requests waiting to be confirmed by the user.
293 Directory containing list specific templates (optional). If this
294 directory exists, templates are searched from it before going for
295 system wide templates. An empty file here means the
296 corresponding message is not sent at all. This can, for example, to
297 be used to turn off the "please wait for moderator" mails on a per\-list
301 Directory containing plugins, Python source files that are loaded
302 automatically by EoC upon startup.
303 The plugins may change how EoC operates.
314 owners = liw@liw.iki.fi
318 mail\-on\-subscription\-changes = yes
319 mail\-on\-forced\-unsubscribe = yes
329 correspond to the options with the same names.
333 List of addresses for the owners. Set with the
338 List of addresses for the moderators. Set with the
342 .B mail\-on\-subscription\-changes
343 Should the owners be mailed when users subscribe or unsubscribe?
345 .B mail\-on\-forced\-unsubscribe
346 Should the owners be mailed when people are removed from the list due to
350 Bounce messages are ignored on this list. Useful for example if
351 list should have static subscriber list.
354 Suffix for templates, to allow support for multiple languages.
357 is set to "fi", then the template named "foo" is first searched as
361 Do not MIME encode the headers. Set to "yes" to not encode, anything
362 else (including empty or unset) means encoding will happen.
364 To create a list called
365 .IR moviefans@example.com ,
367 .IR ding@example.com ,
368 use the following command (all on one line):
372 enemies\-of\-carlotta \-\-name=moviefans@example.com
373 \-\-owner=ding@example.com \-\-create
377 Note that you need to arrange mail to arrive at the list (and its
378 command addresses) by configuring your mail system.
379 For Qmail and Postfix, see below.
381 To see the subscribers on that list:
385 enemies\-of\-carlotta \-\-name=moviefans@example.com \-\-list
389 People wanting to subscribe to the list should mail
393 moviefans\-subscribe@example.com
397 With QMail, to arrange for incoming mail to be processed by Enemies of
398 Carlotta, you need to create a couple of
401 For example, if your username is joe and you wish to run the
402 joe\-fans mailing list, you need to create two files,
405 .IR .qmail\-fans\-default ,
409 |enemies\-of\-carlotta \-\-incoming
412 If you're running a virtual domain, example.com, and the mails are
413 being delivered to via
414 .I /var/qmail/control/virtualdomains
416 .IR joe\-exampledotcom ,
417 the files would be called
418 .I .qmail\-exampledotcom\-fans
420 .I .qmail\-exampledotcom\-fans\-default
424 |enemies\-of\-carlotta \-\-incoming \-\-skip\-prefix=joe\-exampledotcom\-
427 (all on one line, of course, in case the manual page formatter breaks it
430 For Courier-MTA, the instructions are similar to the Qmail ones above.
431 If your user name is joe and you wish to run the joe-fans email list,
432 you need to create the two files .courier-fans and .courier-fans-default
433 in your home directory with the content
436 |enemies-of-carlotta --is-list --name $RECIPIENT || exit 67
438 |enemies-of-carlotta --incoming
441 (The former file needs only the second line, but the first line does no
442 harm and it is easier to keep track of things when the files have the
443 same content. Note that $RECIPIENT should be included verbatim, it is
444 not a metavariable for you to expand.)
446 If you are running a virtual domain configured so that all mail to the
447 domain @example.com is delivered to joe-exampledotcom, you need to
448 create the files .courier-exampledotcom-fans and
449 .courier-exampledotcom-fans-default containing the two following lines:
452 |enemies-of-carlotta --is-list --name $RECIPIENT --skip-prefix=joe-exampledotcom || exit 67
454 |enemies-of-carlotta --incoming --skip-prefix=joe-exampledotcom
457 If the virtual domain is for list use only, then it is sufficient to
458 create only the file .courier-exampledotcom-default containing the
461 With Postfix, you need to set up a
476 * ? enemies\-of\-carlotta \-\-name=$RECIPIENT \-\-is\-list
478 | enemies\-of\-carlotta \-\-incoming
481 To use Enemies of Carlotta with a Postfix virtual domain, you need to
483 .IR "virtual regular expression map" ,
485 .I /etc/postfix/virtual_regexp
487 .I "virtual_maps = regexp:/etc/postfix/virtual_regexp"
489 .I /etc/postfix/main.cf
491 The regexp file needs to do ugly things to preserve the recipient
493 Add the following to the regexp file:
496 /^your\.virtual\.domain$/ dummy
498 /^(yourlist|yourlist\-.*)@(your\.virtual\.domain)$/ joe+virtual\-$1
501 That's two lines. Use
504 .I recipient_delimiter
505 for your Postfix is configured to a minus instead of a plus..
509 .I "\-\-skip\-prefix=joe\-virtual\-"
511 .I \-\-domain=your.virtual.domain
512 options to both calls to
513 .BR enemies\-of\-carlotta .
515 (Yes, I think these things are much too complicated, too.)
517 Users and list owners use Enemies of Carlotta via e\-mail using
518 command addresses such as
519 .BR foo\-subscribe@example.com .
520 Here is a list of all command addresses list users and owners can give.
521 In all these examples, the name of the mailing list is
522 .BR foo@example.com .
523 .SS "Mail commands anyone can use"
524 These commands are meant for everyone's use.
525 They don't require any special priviledges.
528 Send mail to all list subscribers.
529 The message may have to be manually approved by the list moderators first,
530 and they have the power to reject a message.
532 .BR foo\-owner@example.com
533 Send mail to the list owner or owners instead.
535 .BR foo\-help@example.com
536 Sending mail to this address makes the list manager reply with
537 the help message for the list.
539 .BR foo\-subscribe@example.com
540 Send mail to this address to subscribe to a list.
541 The list manager will respond with a confirmation request.
542 You won't be subscribed unless you reply to the confirmation request.
543 This way, malicious people can't put your address on a mailing list,
544 or many mailing lists.
546 .BR foo\-subscribe\-joe=example.com@example.com
547 This is a second form of the subscription address.
548 If you want to subscribe to the list with another address than the
549 one you're sending mail from, use this one.
550 In this case, the address to be subscribed is joe@example.com.
551 Note that the confirmation request is sent to Joe, since it is
552 his address that is to be added to the list.
554 .BR foo\-unsubscribe@example.com
555 To unsubscribe from a list, send mail to this address from the address
556 that is subscribed to the list.
557 Again, you will receive a confirmation request, to prevent malicious
558 people from unsubscribing you against your will.
560 .BR foo\-unsubscribe\-joe=example.com@example.com
561 To unsubscribe Joe, use this address.
562 Again, it is Joe who gets to confirm.
563 .SS "Mail commands for the list owners"
564 These are commands that list owners can use to administer their list.
566 .BR foo\-subscribe\-joe=example.com@example.com
567 If a list owner sends mail like this, it is they who get the confirmation
569 It is generally better for people to subscribe themselves, but sometimes
570 list owners want to do it, when they have permission from the person
573 .BR foo\-unsubscribe\-joe=example.com@example.com
574 List owners can also unsubscribe other people.
576 .BR foo\-list@example.com
577 To see who are on the list, this is the address to use.
578 It only works if the sender address is one of the list owners.
579 The sender address is the one used on the SMTP level,
580 not the one in the From: header.
582 .BR foo\-setlist@example.com
583 This lets a list owner set the whole subscriber list at once.
584 This is similar to using lots and lots and lots of \-subscribe and
585 \-unsubscribe commands, only less painful.
586 Everyone who is added to the list gets a welcome message, and
587 everyone who is removed from the list gets a goodbye message.
589 .BR foo\-setlistsilently@example.com
590 This is similar to \-setlist, but no welcome and goodbye messages are sent.
592 Enemies of Carlotta supports plugins.
593 If you don't know what Python programming is, you may want to skip this
596 A plugin is a Python module (file named with a
598 suffix), placed in the
599 .B ~/.enemies\-of\-carlotta/plugins
601 The plugins are loaded automatically upon startup, if their declared
602 interface version matches the one implemented by Enemies of Carlotta.
603 The interface version is declared by the module global variable
604 .BR PLUGIN_INTERFACE_VERSION .
606 Plugins can define hook functions that are called by appropriate places in
608 At the moment, the only hook function is
609 .BR send_mail_to_subscribers_hook ,
610 which can manipulate a mail message before it is sent to the subscribers.
611 The function must look like this:
614 def send_mail_to_subscribers_hook(list, text):
618 argument is a reference to the
620 object that corresponds to the list in question, and
622 is the complete text of the mail message as it exists.
623 The function must return the new contents of the mail message.
626 .I ~/.enemies\-of\-carlotta
627 All files related to your mailing lists.
629 .I ~/.enemies\-of\-carlotta/secret
630 Secret password used to generate signed addresses for bounce checking
631 and subscription verification.
633 .I ~/.enemies\-of\-carlotta/foo@example.com
634 Directory containing data pertaining to the foo@example.com list.
637 file in this directory, you shouldn't edit anything by hand.
639 .I ~/.enemies\-of\-carlotta/foo@example.com/config
640 Configuration file for the mailing list.
641 You may need to edit this file by hand if you wish to change moderation
642 status or list owners.
644 You may want to visit the
645 .I "Enemies of Carlotta"
647 .IR http://www.iki.fi/liw/eoc/ .
projects / eoc.git / blob