| 1 | .TH qlist 1 |
| 2 | .SH NAME |
| 3 | qlist \- handle mailing list subscription requests |
| 4 | .SH SYNOPSIS |
| 5 | in |
| 6 | .BR .qmail-\fIlist-request : |
| 7 | .br |
| 8 | .B |qlist |
| 9 | .I user-list@host |
| 10 | .I user-list-request@host |
| 11 | .br |
| 12 | .B .qmail-\fIlist |
| 13 | .B .qmail-\fIlist-request |
| 14 | .B .qtemp-\fIlist |
| 15 | .br |
| 16 | .I owner |
| 17 | [ |
| 18 | .I moreinfo |
| 19 | ] |
| 20 | .br |
| 21 | (all on one line) |
| 22 | .SH DESCRIPTION |
| 23 | .B qlist |
| 24 | manages a |
| 25 | .B qmail |
| 26 | mailing list. |
| 27 | |
| 28 | When |
| 29 | .B qlist |
| 30 | receives a message, |
| 31 | it looks through the body of the message for commands. |
| 32 | .B WARNING: |
| 33 | .B qlist |
| 34 | looks for a command only at the beginning of a line. |
| 35 | Exception: |
| 36 | .B qlist |
| 37 | also looks at |
| 38 | .B Subject |
| 39 | lines. |
| 40 | |
| 41 | .B qlist |
| 42 | supports two commands. |
| 43 | .B SUBSCRIBE |
| 44 | adds a new subscription to the mailing list; |
| 45 | .B UNSUBSCRIBE |
| 46 | removes a subscription. |
| 47 | .B qlist |
| 48 | looks for the subscription address in the |
| 49 | .BR Reply-To , |
| 50 | .BR From , |
| 51 | or |
| 52 | .BR Return-Path |
| 53 | fields in the message. |
| 54 | |
| 55 | .B qlist |
| 56 | inserts an acknowledgment of each action it took, |
| 57 | along with general help instructions, into the message. |
| 58 | It then forwards the message to the subscription address, |
| 59 | with a copy to |
| 60 | .IR owner . |
| 61 | |
| 62 | .BR qlist 's |
| 63 | general help instructions identify |
| 64 | .I user-list@host |
| 65 | as the address of the mailing list, |
| 66 | .I user-list-request@host |
| 67 | as the address of |
| 68 | .B qlist |
| 69 | itself, and |
| 70 | .I owner |
| 71 | as the address |
| 72 | of the mailing list owner. |
| 73 | If |
| 74 | .I moreinfo |
| 75 | is supplied, |
| 76 | it is inserted into the middle of the instructions, |
| 77 | surrounded by blank lines. |
| 78 | |
| 79 | .B qlist |
| 80 | maintains its address list in |
| 81 | .BR .qmail-\fIlist , |
| 82 | so mail to |
| 83 | .I user-list |
| 84 | will be forwarded to each subscription address. |
| 85 | While |
| 86 | .B qlist |
| 87 | is editing |
| 88 | .BR .qmail-\fIlist , |
| 89 | it locks |
| 90 | .BR .qmail-\fIlist-request . |
| 91 | It uses |
| 92 | .B .qtemp-\fIlist |
| 93 | as a temporary file. |
| 94 | |
| 95 | Note that |
| 96 | .B qlist |
| 97 | only manipulates lines beginning with an ampersand; |
| 98 | if you manually add an address without an ampersand, |
| 99 | it cannot be removed by |
| 100 | .BR qlist . |
| 101 | |
| 102 | .B qlist |
| 103 | automatically sets the execute bit on |
| 104 | .BR qmail-\fIlist , |
| 105 | so |
| 106 | .B qmail-local |
| 107 | will ignore any program or file instructions in |
| 108 | .BR qmail-\fIlist . |
| 109 | .SH "SEE ALSO" |
| 110 | dot-qmail(5), |
| 111 | envelopes(5), |
| 112 | qmail-queue(8) |