home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / hensa / comms / maillist_1 / !MailList / Docs / Scheduler < prev    next >
Text File  |  1995-03-19  |  5KB  |  149 lines
  1. Using the Scheduler
  2. ===================
  3.  
  4. From v0.10 onwards MailList incorporates a (very simple) Scheduler.
  5. This allows you to let MailList post messages on a periodic (eg. every
  6. month) basis. Both news and mail can be scheduled for posting. There are
  7. two ways of scheduling a message:
  8.  
  9.         1. Direct
  10.         2. Linked
  11.  
  12. Directly scheduling a message
  13. -----------------------------
  14.  
  15.  o      Create a mail or news-message using !TTFN/!Edit (preferred) or
  16.         an alternative application.
  17.  o      The header must be a full RFC-822 (mail) or USEnet (news)
  18.         compliant header (see "Headers" below).
  19.  o      Instead of posting the message save it in the directory
  20.         '!MailList.Scheduler'. (The filename "Links" is reserved!)
  21.  o      Finally edit the message with your favourite text-editor and add
  22.         the Scheduler-CommandLine. The Scheduler-CLI MUST be the first
  23.         line in the file and must be followed directly by the first
  24.         header-line of the message. No empty lines are allowed
  25.         inbetween.
  26.  
  27. Scheduling a linked message
  28. ---------------------------
  29.  
  30.  o      Create a textfile with your favourite editor.
  31.  o      The first (and only) line in the file contains the
  32.         Scheduler-CLI including the path where the actual message is
  33.         stored.
  34.  o      Save the file to the directory '!MailList.Scheduler'. (The
  35.         filename "Links" is reserved!) 
  36.  
  37. Alternatively, if you have a lot of files scheduled, you may find that
  38. Acorn's Filing System can't cope with more than 77 files. This is where
  39. the file '!MailList.Scheduler.Links' comes in handy. This file is
  40. assumed to contain a list of Scheduler-CLI's. So, instead of creating
  41. one file per link you can also put all the links in this file.
  42.  
  43. NOTE: The latter method (using the "Links" file) is prefered!
  44.  
  45. The Scheduler-CLI
  46. -----------------
  47.  
  48. The Scheduler-CLI must be the first line in the file (with exception of the
  49. "Links" file). In case of a linked message this is also the only line in the
  50. file. Otherwise, the message-header should immediately follow the
  51. Scheduler-CLI. NO EMPTY LINES INBETWEEN!!!
  52.  
  53. Scheduler-CLI format:
  54.  
  55.         <ScheduledDate> <Repeater> [<path>]
  56.  
  57. Scheduler-CLI syntax:
  58.  
  59.         <ScheduledDate> The date in ISO-format (YYYYMMDD) on which the
  60.                         message is to be sent.
  61.  
  62.         <Repeater>      Number of days, weeks, months or years after
  63.                         which the file should be sent again.
  64.                         Format: <T><n>
  65.                         Where <T> is either D, W, M or Y for days,
  66.                         weeks, months and years respectively and <n> is
  67.                         the number of <T>. 
  68.  
  69.         <path>          In case of a linked message: the path where the
  70.                         actual message is stored.
  71.  
  72. Example 1:
  73.  
  74.    19950212 M1 
  75.    From: listsurv@cray-3.xs4all.nl
  76.    To: BitFTP@DEARN.BITNET
  77.    Subject: FTP Request (Hensa Index)
  78.  
  79.  
  80.    FTP micros.hensa.ac.uk UUENCODE
  81.    CD  micros/arch/riscos
  82.    GET index
  83.    QUIT
  84.  
  85. This file is scheduled to be sent on 12-Feb-1995 (19950212). It will be
  86. repeated every month (M1). So, when MailList sends out this message it
  87. will change the Scheduler-CLI to: '19950312 M1' meaning that it will be
  88. sent on 12-Mar-1995 again. 
  89.  
  90. Example 2:
  91.  
  92.     19950301 W3 ADFS::IDEDisc4.$.Some.Arbitrary.Path.filename
  93.  
  94. This file is scheduled to be sent out on 1-Mar-1995 (19950301). It will
  95. be repeated every 3 weeks (W3) - that's 3*7 days -. And the file that is
  96. sent is stored somewhere else on the disc as:
  97.  
  98.   'ADFS::IDEDisc4.$.Some.Arbitrary.Path.filename'
  99.  
  100. The advantage here is that you can, for instance, maintain an FAQ which
  101. you store on the MailServer path and have it posted periodically by the
  102. Scheduler. Then people can request the file from the MailServer and the
  103. Scheduler can find it aswell while you only need one copy of the file on
  104. disc.
  105.  
  106. *** Hint: To get a path into a textfile you don't have to type it in.
  107.           Just Shift-Drag the file into the text-window and the file's
  108.           path/filename will be entered at the position of the cursor.
  109.  
  110. Example 3:
  111.  
  112. The file '!MailList.Scheduler.Links' could look something like this:
  113.  
  114.     19950301 W3 ADFS::IDEDisc4.$.Some.Arbitrary.Path1.filename1
  115.     19950301 D2 ADFS::IDEDisc4.$.Some.Arbitrary.Path1.filename2
  116.     19950312 Y1 ADFS::IDEDisc4.$.BirthDay.Greetings.Maurice
  117.     19950301 M1 ADFS::IDEDisc4.$.Some.Different.Path.MyFAQ
  118.  
  119.  
  120. Headers
  121. -------
  122.  
  123. RFC-822 compliant header can look something like this:
  124.  
  125.  From: ...
  126.  To: ...
  127.  Subject: ...
  128.  
  129. This is a minimum requirement. More header lines may be included. The
  130. From: header should be first.
  131.  
  132. USENET compliant header can look something like this:
  133.  
  134.  Path: ...
  135.  Newsgroups: ...
  136.  From: ...
  137.  Subject: ...
  138.  
  139. This is the minimum requirement. Other headers may be added. Path:
  140. should be the first header-line. Newsgroups: identifies the posting as
  141. news.
  142.  
  143. Notes
  144. -----
  145.  
  146. As I said before, the Scheduler is very simple. For instance: it assumes
  147. months are always 31 days long. If this is a problem I may be persuaded
  148. to add a proper date-calculating algorithm. 
  149.