Update manuals for CVS and new commands
[spider.git] / html / adminmanual_en-3.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2 <HTML>
3 <HEAD>
4  <META NAME="GENERATOR" CONTENT="LinuxDoc-Tools 0.9.20">
5  <TITLE>The DXSpider Administration Manual v1.51: Mail</TITLE>
6  <LINK HREF="adminmanual_en-4.html" REL=next>
7  <LINK HREF="adminmanual_en-2.html" REL=previous>
8  <LINK HREF="adminmanual_en.html#toc3" REL=contents>
9 <link rel=stylesheet href="style.css" type="text/css" title="default stylesheet">
10 </HEAD>
11 <BODY>
12 <A HREF="adminmanual_en-4.html">Next</A>
13 <A HREF="adminmanual_en-2.html">Previous</A>
14 <A HREF="adminmanual_en.html#toc3">Contents</A>
15 <HR>
16 <H2><A NAME="s3">3.</A> <A HREF="adminmanual_en.html#toc3">Mail</A></H2>
17
18 <P>DXSpider deals seamlessly with standard AK1A type mail.  It supports both
19 personal and bulletin mail and the sysop has additional commands to ensure
20 that mail gets to where it is meant.  DXSpider will send mail almost
21 immediately, assuming that the target is on line.  However, only one
22 mail message is dealt with at any one time.  If a mail message is already
23 being sent or recieved, then the new message will be queued until it has
24 finished.</P>
25 <P>The cluster mail is automatically deleted after 30 days unless the sysop
26 sets the "keep" flag using the <EM>msg</EM> command.</P>
27
28 <H2><A NAME="ss3.1">3.1</A> <A HREF="adminmanual_en.html#toc3.1">Personal mail</A>
29 </H2>
30
31 <P>Personal mail is sent using the <EM>sp</EM> command.  This is actually the
32 default method of sending mail and so a simple <EM>s</EM> for send will do.
33 A full list of the send commands and options is in the <EM>command set</EM>
34 section, so I will not duplicate them here.</P>
35
36 <H2><A NAME="ss3.2">3.2</A> <A HREF="adminmanual_en.html#toc3.2">Bulletin mail</A>
37 </H2>
38
39 <P>Bulletin mail is sent by using the <EM>sb</EM> command.  This is one of the
40 most common mistakes users make when sending mail.  They send a bulletin
41 mail with <EM>s</EM> or <EM>sp</EM> instead of <EM>sb</EM> and of course
42 the message never leaves the cluster.  This can be rectified by the sysop
43 by using the <EM>msg</EM> command.</P>
44
45 <P>Bulletin addresses can be set using the Forward.pl file.</P>
46
47 <H2><A NAME="ss3.3">3.3</A> <A HREF="adminmanual_en.html#toc3.3">Forward.pl</A>
48 </H2>
49
50 <P>DXSpider receives all and any mail sent to it without any alterations needed
51 in files.  Because personal and bulletin mail are treated differently, there
52 is no need for a list of accepted bulletin addresses.  It is necessary, however,
53 to tell the program which links accept which bulletins.  For example, it is
54 pointless sending bulletins addresses to "UK" to any links other than UK
55 ones.  The file that does this is called forward.pl and lives in /spider/msg.
56 At default, like other spider files it is named forward.pl.issue.  Rename it
57 to forward.pl and edit the file to match your requirements.
58 The format is below ...</P>
59 <P>
60 <BLOCKQUOTE><CODE>
61 <PRE>
62 #
63 # this is an example message forwarding file for the system
64 #
65 # The format of each line is as follows
66 #
67 #     type    to/from/at pattern action  destinations
68 #     P/B/F     T/F/A     regex   I/F    [ call [, call ...] ]
69 #
70 # type: P - private, B - bulletin (msg), F - file (ak1a bull)
71 # to/from/at: T - to field, F - from field, A - home bbs, O - origin 
72 # pattern: a perl regex on the field requested
73 # action: I - ignore, F - forward
74 # destinations: a reference to an array containing node callsigns
75 #
76 # if it is non-private and isn't in here then it won't get forwarded 
77 #
78 # Currently only type B msgs are affected by this code.
79
80 # The list is read from the top down, the first pattern that matches
81 # causes the action to be taken.
82 #
83 # The pattern can be undef or 0 in which case it will always be selected
84 # for the action specified
85 #
86 # If the BBS list is undef or 0 and the action is 'F' (and it matches the
87 # pattern) then it will always be forwarded to every node that doesn't have 
88 # it (I strongly recommend you don't use this unless you REALLY mean it, if
89 # you allow a new link with this on EVERY bull will be forwarded immediately
90 # on first connection)
91 #
92
93 package DXMsg;
94
95 @forward = (
96 'B',    'T',    'LOCAL',        'F',    [ qw(GB7MBC) ],
97 'B',    'T',    'ALL',          'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
98 'B',    'T',    'UK',           'F',    [ qw(GB7BAA GB7ADX) ],
99 'B',    'T',    'QSL',          'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
100 'B',    'T',    'QSLINF',       'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
101 'B',    'T',    'DX',           'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
102 'B',    'T',    'DXINFO',       'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
103 'B',    'T',    'DXNEWS',       'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
104 'B',    'T',    'DXQSL',        'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
105 'B',    'T',    'SYSOP',        'F',    [ qw(GB7BAA GB7ADX) ],
106 'B',    'T',    '50MHZ',        'F',    [ qw(GB7BAA GB7ADX PA4AB-14) ],
107 );
108 </PRE>
109 </CODE></BLOCKQUOTE>
110 </P>
111 <P>Simply insert a bulletin address and state in the brackets where you wish
112 that mail to go.  For example, you can see here that mail sent to "UK" will
113 only be sent to the UK links and not to PA4AB-14.</P>
114
115 <P>To force the cluster to reread the file use load/forward</P>
116
117 <P>NB: If a user tries to send mail to a bulletin address that does not exist
118 in this file, they will get an error.</P>
119
120 <H2><A NAME="ss3.4">3.4</A> <A HREF="adminmanual_en.html#toc3.4">The msg command</A>
121 </H2>
122
123 <P>The <EM>msg</EM> command is a very powerful and flexible tool for the
124 sysop.  It allows the sysop to alter to and from fields and make other
125 changes to manage the cluster mail.</P>
126 <P>Here is a full list of the various options ...</P>
127 <P>
128 <BLOCKQUOTE><CODE>
129 <PRE>
130   MSG TO &lt;msgno> &lt;call>     - change TO callsign to &lt;call>
131   MSG FRom &lt;msgno> &lt;call>   - change FROM callsign to &lt;call>
132   MSG PRrivate &lt;msgno>      - set private flag
133   MSG NOPRrivate &lt;msgno>    - unset private flag
134   MSG RR &lt;msgno>            - set RR flag
135   MSG NORR &lt;msgno>          - unset RR flag
136   MSG KEep &lt;msgno>          - set the keep flag (message won't be deleted ever)
137   MSG NOKEep &lt;msgno>        - unset the keep flag
138   MSG SUbject &lt;msgno> &lt;new> - change the subject to &lt;new>
139   MSG WAittime &lt;msgno>      - remove any waiting time for this message
140   MSG NOREad &lt;msgno>        - mark message as unread
141   MSG REad &lt;msgno>          - mark message as read
142   MSG QUeue                 - queue any outstanding bulletins
143   MSG QUeue 1               - queue any outstanding private messages
144 </PRE>
145 </CODE></BLOCKQUOTE>
146 </P>
147 <P>These commands are simply typed from within the cluster as the sysop user.</P>
148
149 <H2><A NAME="ss3.5">3.5</A> <A HREF="adminmanual_en.html#toc3.5">Message status</A>
150 </H2>
151
152 <P>You can check on a message from within the cluster by using the command
153 <EM>stat/msg</EM>.  This will give you additional information on the
154 message number including which nodes have received it, which node it
155 was received from and when etc.  Here is an example of the output of
156 the command ...</P>
157 <P>
158 <BLOCKQUOTE><CODE>
159 <PRE>
160 G0VGS de GB7MBC 28-Jan-2001 1308Z >
161 stat/msg 6869
162         From: GB7DJK
163     Msg Time: 26-Jan-2001 1302Z
164        Msgno: 6869
165       Origin: GB7DJK
166         Size: 8012
167      Subject: AMSAT 2line KEPS 01025.AMSAT
168           To: UK
169 Got it Nodes: GB7BAA, GB7ADX
170      Private: 0
171 Read Confirm: 0
172   Times read: 0
173 G0VGS de GB7MBC 28-Jan-2001 1308Z >
174 </PRE>
175 </CODE></BLOCKQUOTE>
176 </P>
177
178 <H2><A NAME="ss3.6">3.6</A> <A HREF="adminmanual_en.html#toc3.6">Filtering mail</A>
179 </H2>
180
181 <P>This is described in the section on <EM>Other filters</EM> so I will not
182 duplicate it here.</P>
183
184 <H2><A NAME="ss3.7">3.7</A> <A HREF="adminmanual_en.html#toc3.7">Distribution lists</A>
185 </H2>
186
187 <P>Distribution lists are simply a list of users to send certain types of
188 mail to.  An example of this is mail you only wish to send to other
189 sysops.  In /spider/msg there is a directory called <EM>distro</EM>.  You
190 put any distibution lists in here.  For example, here is a file called
191 SYSOP.pl that caters for the UK sysops.</P>
192 <P>
193 <BLOCKQUOTE><CODE>
194 <PRE>
195 qw(GB7TLH GB7DJK GB7DXM GB7CDX GB7BPQ GB7DXN GB7MBC GB7MBC-6 GB7MDX
196    GB7NDX GB7SDX GB7TDX GB7UDX GB7YDX GB7ADX GB7BAA GB7DXA GB7DXH 
197    GB7DXK GB7DXI GB7DXS)
198 </PRE>
199 </CODE></BLOCKQUOTE>
200 </P>
201 <P>Any mail sent to "sysop" would only be sent to the callsigns in this list.</P>
202
203 <H2><A NAME="ss3.8">3.8</A> <A HREF="adminmanual_en.html#toc3.8">BBS interface</A>
204 </H2>
205
206 <P>Spider provides a simple BBS interface.  No input is required from the sysop
207 of the cluster at all.  The BBS simply sets the cluster as a BBS and pushes
208 any required mail to the cluster.  No mail can flow from Spider to the BBS,
209 the interface is one-way.</P>
210
211 <P>Please be careful not to flood the cluster network with unnecessary mail.
212 Make sure you only send mail to the clusters that want it by using the
213 Forward.pl file very carefully.</P>
214
215 <HR>
216 <A HREF="adminmanual_en-4.html">Next</A>
217 <A HREF="adminmanual_en-2.html">Previous</A>
218 <A HREF="adminmanual_en.html#toc3">Contents</A>
219 </BODY>
220 </HTML>