]> code.citadel.org Git - citadel.git/blob - citadel/mailinglists.txt
Initial revision
[citadel.git] / citadel / mailinglists.txt
1                 BIDIRECTIONAL MAILING LIST GATEWAY INSTRUCTIONS
2  
3    Citadel/UX now has the ability to host a room on the BBS as a
4 bidirectional gateway to an Internet mailing list.  This makes it convenient
5 for the entire BBS community to have reading and posting access to a mailing
6 list without each member having to subscribe to the list.  This document
7 describes the procedure for setting up such functionality.
8  
9    Here's the prerequisite: you must be using Citadel as your system's local
10 mail delivery agent.  Please refer to network.doc for information on how to
11 do this.  Before attempting a mailing list, make sure that you can send and
12 receive regular Internet e-mail from your Citadel system.
13  
14    As you may or may not know, once Citadel is your e-mail system, each room
15 on the system has an e-mail address that may be used to post to the room
16 from anywhere on the Internet.  That address is of the form
17 "room_roomname@yourhost.dom", where "roomname" is the name of the room
18 (spaces replaced by underscores) and "yourhost.dom" is your fully-qualified
19 domain name.
20  
21    The first step is to create a room for the list and then subscribe that
22 room to the list.  The procedure for subscribing to a list depends on what
23 type of software the list server is running, and is beyond the scope of this
24 document.  For the purpose of example, let us suppose that you wish to
25 subscribe to the "Broccoli Advocates" mailing list, and you've discovered
26 that the list administrator is at broccoli-request@stalks.com and messages
27 to be posted to the list should be mailed to broccoli@stalks.com.  Let us
28 further suppose that your BBS is at mybbs.org.
29  
30    So you create a room called "Broccoli Advocates".  Then, because you're a
31 conscientous system administrator, you give the room an Info file which
32 warns users that all messages posted to the room will be posted to the list.
33  
34    You then send e-mail to the list administrator at
35 broccoli-request@stalks.com requesting that the address
36 "room_broccoli_advocates@mybbs.org" be added to the list.  Once the
37 administrator sets this up, the receiving end of the list is set up.  Note
38 that if a receive-only setup is all you want, you can stop here and you're
39 done.
40  
41    Now you have to set things up for sending.   The first thing you have to
42 do is set up the file "mailinglists" which resides in the "network"
43 subdirectory, which holds a table of list addresses associated with each
44 room.  Each line is of the form
45  
46  list-address,Room Name
47  
48  ...one room per line.  You'll use this same file to set up all mailing list
49 references.  So for our example, the line
50  
51  broccoli@stalks.com,Broccoli Advocates
52  
53  should be added.  In other words, messages originating from the "Broccoli
54 Advocates" room will be mailed to broccoli@stalks.com.
55  
56  The next thing to do is create a file in the "network/systems" subdirectory
57 which spools out new messages.  Create a file "network/systems/mailinglists"
58 which looks like this:
59  
60  mailinglist <%s
61  Broccoli Advocates
62  0
63  
64  Note that one systems entry may be used for all mailing lists to which you
65 subscribe.  Just keep adding any rooms (refer to network.doc for the
66 procedure) that are mapped to mailing lists.
67  
68  Now you're done!  Just do a "netproc mailinglists" or "netproc all" on a
69 regular basis (probably using cron or a similar scheduling utility) to batch
70 up new messages and send them out on a regular basis.
71  
72   
73  NOTES ABOUT MAILING LISTS:
74  
75    Since many listservers will only accept postings from e-mail addresses
76 which are subscribed to the list, the mailing list gateway software sets the
77 sending address of each message to the address of the room.  The "full name"
78 portion of the address will remain intact.  So the posted messages will have
79 headers which look like this:
80  
81  From: room_broccoli_advocates@mybbs.org (Joe User)
82  To: broccoli@stalks.org
83  
84    This ensures that messages are properly posted, but it makes it difficult
85 for other members of the list to learn the correct e-mail addresses of the
86 users on your system.  However, since there's so much spam around these
87 days, that's probably just as well anyway.
88  
89    To prevent loops, the mailing list gateway software only spools out
90 messages which originated on _your_ system.  This implies that it is not
91 possible to carry a gatewayed room on any type of Citadel network.
92  
93  
94    Well, that's just about it.  If you have any comments, suggestions, or
95 questions, please visit UNCENSORED! BBS, either on the Internet at
96 uncnsrd.mt-kisco.ny.us or via dialup at 914-244-3252.