home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 October / macformat-029.iso / mac / Shareware City / Comms / AutoShare 1.0 / AutoShare / Documentation / Text / AutoShare Documentation
Encoding:
Text File  |  1995-06-07  |  41.2 KB  |  952 lines  |  [TEXT/R*ch]
  1. -----------------------------------------------------------------------------
  2. AutoShare 1.0 documentation
  3. AutoShare, a freeware MailShare utility
  4. An auto-responder and listserver for the Macintosh
  5. The AutoShare software is © 1994-1995 Mikael Hansen
  6. Document last updated: June 7 1995 for version 1.0
  7. © 1994-1995 Mikael Hansen <meh@admin2.kb.bib.dk>
  8. (beta testers, please use <meh@admin3.kb.bib.dk>)
  9. The credits are located in the AutoShare About box
  10. -----------------------------------------------------------------------------
  11.  
  12. Table of Contents
  13.  
  14.      I. About AutoShare
  15.           1. MailShare and MacTCP
  16.           2. Internet resources
  17.           3. MailShare and AutoShare
  18.           4. Auto-answering service
  19.           5. Vacation service
  20.           6. Listserver
  21.           7. UUCP-MailShare gateway
  22.     II. How to install AutoShare
  23.           1. Folders
  24.           2. Files
  25.           3. AutoShare Preferences
  26.           4. Subject based text files
  27.           5. E-mail header
  28.           6. Bounce address
  29.         7. AutoShare Hosts definitions
  30.           8. Filter definitions
  31.           9. Logs
  32.    III. Running AutoShare
  33.     IV. AutoShare the listserv way
  34.           1. Commands
  35.         2. Multi-command mail
  36.           3. Lists
  37.      V. Loop detection and elimination
  38.     VI. And then ...
  39.    VII. Undocumented features
  40.   VIII. The small print
  41.  
  42. -----------------------------------------------------------------------------
  43.  
  44. I. About AutoShare
  45.  
  46. AutoShare is a MailShare utility that lets you create an auto-answering service.
  47. You may use it as a vacation service as well. AutoShare has also been extended to
  48. function as a listserver. Furthermore, an (outgoing)UUCP-MailShare gateway
  49. is included.
  50.  
  51. Binhex enclosures accompanying automated responses are optional. The enclosures
  52. may be created using StuffIt or Compact Pro (use conversion to BinHex 4.0); the
  53. two software packages are shareware and available from your local Info-Mac mirror
  54. site.
  55.  
  56. Below is an outline of what AutoShare adds to your MailShare server environment:
  57.  
  58. auto-response system 
  59.   specific responses based on subject (or no subject) 
  60.   supports BinHex enclosures 
  61.   you may set up as many accounts as you wish to 
  62. vacation notices 
  63.   optionally adds sender's text 
  64.   supports filters 
  65. simple listserver features 
  66.   offers one listserver and as many lists as you would like 
  67.   main commands are list, review, subscribe, unsubscribe 
  68.   another command is set; the following options are supported: 
  69.     conceal and noconceal
  70.     digest and nodigest 
  71.     mail and nomail 
  72.     ack and noack 
  73.   yet other commands are index, get, which, release and query 
  74.   extended alias commands are: 
  75.     sub:    subscribe
  76.     unsub:  unsubscribe and signoff
  77.     list:   lists
  78.     review: rev, recipients and who
  79.     index:  ind
  80.     get:    send
  81.   other commands such as help may be created 
  82.   archives formatted as text or HTML 
  83. UUCP-MailShare gateway  
  84.   lets Eudora and MailShare communicate via AppleTalk 
  85. Miscellaneous  
  86.   Logs are automatically sent to the administrator 
  87.   Bounce address feature is included 
  88.  
  89. 1. MailShare and MacTCP
  90.  
  91. MailShare is a Macintosh based POP3 and SMTP e-mail server by Glenn Anderson. It
  92. is freeware and can be downloaded from your local Info-Mac mirror site (in the
  93. directory comm/tcp/mail).
  94.  
  95. MacTCP is a commercial product from Apple. An introduction to MacTCP (mactcp.txt)
  96. written by Eric Behr can be obtained by anonymous ftp to ftp.math.niu.edu (in the
  97. directory /pub/mac/doc) or by gopher to gopher.math.niu.edu (directory "Various
  98. documents"). Or the Web way at http://www.math.niu.edu/~behr/docs/mactcp.html.
  99.  
  100. 2. Internet resources
  101.  
  102. AutoShare and MailShare
  103.  
  104. • Released versions of both AutoShare and MailShare are freeware and can be
  105. downloaded from your local Info-Mac mirror site (in the directory
  106. comm/tcp/mail).
  107. • Mikael Hansen maintains an AutoShare list for the discussion of non-public
  108. beta versions of AutoShare: write to autoshare@admin2.kb.bib.dk with a
  109. body of 'sub autoshare.beta <name>'; the return message will inform you of how
  110. to obtain the current beta version. You may want to peek at the general
  111. information at autoshare.info@admin2.kb.bib.dk first. The AutoShare web site is
  112. at http://www2.kb.bib.dk/Staff/meh/AutoShare/AutoShare.html.
  113. • Don W. Strickland maintains an AutoShare list for the discussion of MailShare:
  114. write to listserv@easy.com with a subject of 'sub MailShare-L <name>'.
  115. • Carl Steadman's MailShare documentation ('MailShare: An E-mail Server for
  116. the Macintosh') is available at http://www.freedonia.com/ism/mail/mail.html
  117. (former http://www.winternet.com/~carl/mailshare/mail.html).
  118. • Web 66: MailShare at
  119. http://web66.coled.umn.edu/Cookbook/MailShare/MailShare.html.
  120. • Macintosh Internet Server Software at
  121. http://www.uwtc.washington.edu/Computing/Internet/ServerSoftware.html.
  122. • Macintosh FTP sites at
  123. http://rever.nmsu.edu/~elharo/faq/software.html.
  124. • Chris Johnson's Cron software at http://gargravarr.cc.utexas.edu/cron/cron.html
  125. may be used with MailShare and AutoShare. He maintains a mailing list entitled
  126. the Macintosh Cron Daemon News List: write to listserv@zimbazi.cc.utexas.edu
  127. with a body of 'subscribe cron-news'.
  128.  
  129. Related sites of interest
  130.  
  131. • One of my favorite newsgroups is comp.sys.mac.comm. A csmc FAQ, in which both
  132. MailShare and AutoShare are mentioned, is posted frequently; csmc is great for
  133. all types of Mac Internet software and communication.
  134. • Eric Behr's MacTCP doc is at http://www.math.niu.edu/~behr/docs/mactcp.html.
  135. • The LISTSERV User Guide is at http://www.earn.net/lug/notice.html.
  136. • To obtain the Mailing List Management (MLM) software FAQ, write
  137. 'get mlm-software faq' in the body of mail to listserv@listserv.net.
  138. • Information on StarNine's ListSTAR (former eMOD) for Macintosh, which is
  139. currently in beta, is available at http://www.starnine.com.
  140. • For Eudora users, there is a (very busy) list called the Eudora Forum: write to
  141. majordomo@qualcomm.com with a body of 'subscribe mac-eudora-forum'.
  142. • Alan Staniforth's AddMail can be found at ftp://ftp.demon.co.uk/pub/mac/addmail/.
  143. • Scott Gruby's NotifyMail can be found at ftp://ftp.hmc.edu/pub/mac/. His
  144. VacationMail can be downloaded from your local Info-Mac mirror site (in the
  145. directory comm/tcp/mail).
  146. • Philippe Casgrain's Auto-send to address and Send file, an auto-reply script
  147. scripts can be downloaded from your local Info-Mac mirror site (in the directory
  148. comm/tcp/mail).
  149. • Jaeson Engle maintains an AutoShare list for the discussion of MIND (former
  150. MacDNS): write to listserv@dronf.org with a body of 'sub mind <name>'.
  151.  
  152. The World-Wide Web
  153.  
  154. • For MacHTTP/WebSTAR users, there is a (rather busy) list called MacHTTP
  155. Talk: write to majordomo@academ.com with a body of 'subscribe machttp-talk'.
  156. • Simon Higgs maintains two AutoShare lists for the discussion of Maxum
  157. Development's MacHTTP/WebSTAR compatible cgi software - NetCloak and NetForms:
  158. write to autoshare@higgs.com with a body of 'sub NetCloak <name>' or 'sub
  159. NetForms <name>' respectively.
  160. • Jeffrey T. Jones has created a World Wide Web page and AppleScript based Common
  161. Gateway Inferface (CGI) that allows people to send AutoShare listserv commands to
  162. a configured mail server. The URL is: http://199.199.102.133/listserv.html. You will
  163. need a web client with form capabilities. Docs for the Listserv.cgi are available
  164. at http://199.199.102.133/lsdocs.html.
  165.  
  166. Macintosh information
  167.  
  168. • INFO-MAC Digest: write to listserv@ricevm1.rice.edu with a body of 'subscribe
  169. info-mac <name>'.
  170. • TidBITS - a newsletter  for Mac users: write to listserv@ricevm1.rice.edu with a
  171. body of 'subscribe tidbits <name>'.
  172. • MacUser is at http://www.ziff.com:8007/~macuser/.
  173. • MacWEEK is at http://www.ziff.com:8006/~macweek/.
  174.  
  175. Some MacUser News articles
  176.  
  177. May 1995: Feature:Making the Internet Connection:
  178. http://www.ziff.com:8007/~macuser/mu_0595/feature1.html
  179. March 1995: 1994 MacUser Eddy Awards:
  180. http://www.ziff.com:8007/~macuser/eddy_winners.html
  181. February 1995: Net Traveler: Hot List:
  182. http://www.ziff.com:8007/~macuser/mu_0295/travel1.html
  183.  
  184. Some MacWEEK News articles
  185.  
  186. • News 05.15.95: Cyberdog to sink teeth into Internet, OpenDoc:
  187. http://www.ziff.com:8006/~macweek/mw_051595/news3.html
  188. • MacWEEK Gateways 03.13.95: New Mac Internet servers on tap:
  189. http://www.ziff.com/~macweek/mw_031395/gateways1.html
  190. • MacWEEK Gateways 03.06.95: Mac servers safer from Internet hackers than
  191. Unix counterparts: http://www.ziff.com/~macweek/mw_030695/gateways3.html
  192. • MacWEEK News 02.27.95: Apple to assemble World-Wide Web server:
  193. http://www.ziff.com/~macweek/mw_022795/news2.html
  194. • MacWEEK News 02.20.95: Mac tools up for Internet service:
  195. http://www.ziff.com/~macweek/mw_022095/news2.html
  196. • MacWEEK News 02.13.95: Macs challenge Unix boxes as midrange Internet servers:
  197. http://www.ziff.com/~macweek/mw_021395/news2.html
  198.  
  199. Interviews
  200.  
  201. The Internet interviews are available at
  202. http://www2.kb.bib.dk/Web/Interviews/Internet-Interviews.html. Versions in Word
  203. and text can be fetched from interviews@admin2.kb.bib.dk.
  204.  
  205. 3. MailShare and AutoShare
  206.  
  207. AutoShare works in tandem with MailShare on the same Macintosh. MailShare version
  208. 1.0b8 or later is needed.
  209.  
  210. In order to use AutoShare, a thorough knowledge of the forwarding options of
  211. MailShare is required (please read the MailShare documentation, e.g.
  212. Carl Steadman's at http://www.freedonia.com/ism/mail/mail.html):
  213.  
  214. • 'Save as files' means that MailShare does not send your mail to your account,
  215. but saves it as files in the folder specified by Save as files for your account.
  216. As for AutoShare, this folder is generally referred to as the 'Filed Mail'
  217. folder. By featuring the 'Incoming Mail' folder, MailShare offers the opposite as
  218. well: properly formatted files put into this folder will be picked up and mailed
  219. by MailShare
  220. • 'Mailing list' means that MailShare sends the mail to the people listed in the
  221. document specified by the Mailing list option for your account
  222. • 'Keep copies' (1.0b9) means that forwarding options such as 'Save as files'
  223. applied to an account mails a copy of the message to this account as well
  224.  
  225. AutoShare relies heavily on these MailShare forwarding options. Please be aware,
  226. that the name of the Incoming Mail folder is up to MailShare and cannot be
  227. changed by the MailShare/AutoShare administrator.
  228.  
  229. AutoShare implements plenty of multi stuff:
  230.  
  231. • more than one account may be configured as an auto-answer (user@... based)
  232. • each auto-answer account is able to return more than one message (subject line
  233. based)
  234. • the listserv auto-answer account is able to support more than one list
  235.  
  236. 4. Auto-answering service
  237.  
  238. You may have heard of automated e-mail response systems or the more specific
  239. term MailBot. AutoShare comes with some basic features and is fairly easy to
  240. use.
  241.  
  242. There is one service per MailShare account. Each account is able to return a
  243. default message or one taken from a multitude of different messages based on the
  244. contents of the subject line.
  245.  
  246. The AutoShare Preferences is essentially the glue that holds everything
  247. together. The name of the Filed Mail folder is specified here; this name must
  248. be referred to in MailShare for all of your AutoShare accounts.
  249.  
  250. The name of the Docs folder must be specified in AutoShare Preferences via the
  251. Preferences menu selection, so that AutoShare knows where to find the text files
  252. to be returned. Inside the Docs folder, you must create subfolders with names
  253. corresponding to the user names of the AutoShare accounts in MailShare. Inside
  254. each subfolder, create a default document called Default. This document is
  255. used for senders not specifying a particular string in the subject line.
  256. Alternate documents may be created, and the subject line of the sender's e-mail
  257. must match one of the names of these documents for it to work.
  258.  
  259. 5. Vacation service
  260.  
  261. Having a MailShare account configured as Save as files combined with Keep copies
  262. ensures proper handling for vacation notices.
  263.  
  264. Filtering can be enabled, so that vacation notices are not returned to for
  265. instance listserv lists or mailing lists. The filtering applies to From, To,
  266. Subject, Reply-To, Sender or any header being one of the five. Inside the
  267. Filters folder, documents containing the filter definition lines are named
  268. according to the user names of the AutoShare accounts in MailShare.
  269.  
  270. A particular aspect is the ability to configure a user's filters file, so that
  271. any given sender will receive one vacation notice only regardless of how many
  272. messages the sender mails to the user on vacation.
  273.  
  274. 6. Listserver
  275.  
  276. A (manual) mailing list is a list of e-mail addresses of people. Eudora
  277. supports this the client way, MailShare supports it the server way. By
  278. turning the mailing list into a listserv (automatic mailing) list, the
  279. people on the list become active subscribers and as such may post messages
  280. directly to a list without the manual assistance of an administrator.
  281. Subscription requests are handled by mailing the listserv address, which
  282. is different from a list address! AutoShare turns your MailShare server
  283. into a listserver, offering you one listserv address and as many lists
  284. as you would like.
  285.  
  286. You may have heard of complex Unix software with specific names such as LISTSERV,
  287. Majordomo or ListProc (to obtain the Mailing List Management (MLM) software
  288. FAQ, write 'get mlm-software faq' in the body of mail to
  289. listserv@listserv.net). AutoShare is by no means as advanced as these software
  290. packages, but the AutoShare documentation does use the generic term listserv(er).
  291. You may be aware of StarNine's (http://www.starnine.com) ListSTAR (former eMOD)
  292. for Macintosh as well, which is currently in beta.
  293.  
  294. The listserver feature has been developed as a natural extension within AutoShare
  295. and of MailShare. The listserv account is merely an auto-answer account, with
  296. some special features added to it; the listserv lists are set up using separate
  297. MailShare accounts (although not possible here, integrating the listserv features
  298. into the list account itself would lead to far too dangerous events: imagine you
  299. wanted to unsubscribe from a list, but misspelled the command, then everyone on
  300. the list would receive the message!).
  301.  
  302. First of all, the user name of the listserv account must be 'autoshare' (as in
  303. 'autoshare@...'). With the listserv account configured as Save as files, you can
  304. run a listserver, supporting the LIST, REVIEW, SUB, UNSUB, SET (CONCEAL,
  305. NOCONCEAL, DIGEST, NODIGEST, MAIL and NOMAIL, ACK and NOACK options), INDEX,
  306. GET, WHICH, RELEASE and QUERY commands. In order to apply listserv lists
  307. configured as MailShare mailing lists, you must specify a listserv folder
  308. in the AutoShare Preferences (the LSFolder folder). After having created the
  309. actual folder as well, put the various listserv mailing lists in the folder and
  310. make sure that the MailShare mailing list accounts are updated to correspond
  311. to the folder. Within a mailing list, AutoShare supports the 'address (name)'
  312. format.
  313.  
  314. Rather than having listserv list messages go directly to the MailShare mailing
  315. lists acting as listserv lists, an AutoShare preview of listserv list messages
  316. has been applied, so that it becomes possible for AutoShare to take a look at
  317. them and sometimes make minor modifications to them. AutoShare is able to distinguish
  318. list messages from other messages.
  319.  
  320. Since listserv is also an auto-answer, remember to create a listserv subfolder
  321. inside the Docs folder. Inside the listserv subfolder, create the
  322. Default as well as the LIST, REVIEW, SUB, UNSUB, SET, INDEX, GET, WHICH,
  323. RELEASE and QUERY documents. In the latter documents, you should specify the
  324. /=list, /=review, /=sub, /=unsub, /=set, /=index, /=get, /=which, /=release and
  325. /=query token pairs respectively; the rest of the text contents is up to you.
  326.  
  327. Listserv list archives, formatted as text or HTML, are created automatically.
  328. One archive file (Current.html), located in a subfolder (named after the list)
  329. inside the Archives folder, per listserv list will accumulate continuously
  330. (rename current files when it's appropriate).
  331.  
  332. The text vs HTML option applies to archives only, not to digests as a digest
  333. is merely a small collection of messages mailed to digest subscribers on a
  334. regular basis.
  335.  
  336. Whenever a list contribution takes place, the digest set of files (current.html
  337. and current.toc) and the archive set of files (digest.html and digest.toc) are
  338. updated: the message and toc (table of content) parts are formatted and then
  339. appended to the respective files. With the GET command, further formatting is
  340. added to form a single text or HTML document (within the begin/end block of the
  341. returned message following the GET request).
  342.  
  343. 7. UUCP-MailShare gateway
  344.  
  345. The (outgoing)UUCP-MailShare gateway feature is aimed at Eudora users on a
  346. LocalTalk network with no access to TCP/IP-inside-AppleTalk encapsulation via a
  347. DDP/IP router connected to Ethernet including a MailShare server. This
  348. MacTCP-less solution is based on simple file transport on AppleTalk, and UUCP has
  349. been chosen, because the UUCP mail spool format is adequate and because Eudora
  350. supports it; UUCP mail per se is not used.
  351.  
  352. Incoming UUCP: The MailShare POP account is configured as 'Save as archive' to an
  353. inspool folder/user (e.g. 'MAILSHARE HD:Misc:inspool:meh'); this forwarding
  354. option satifies Eudora's expections of the mail drop being in the standard Unix
  355. mailbox format. The Eudora part (Settings, POP Account, e.g. '!MAILSHARE
  356. HD:Misc:inspool:meh') is made possible thru the use of file sharing applied to
  357. the MailShare server's harddisk.
  358.  
  359. Outgoing UUCP: The Eudora part (Settings, SMTP, e.g. '!MEH HD!MAILSHARE
  360. HD:Misc:Filed Mail:!meh!0000') is possible thru the use of file sharing to the
  361. standard Filed Mail folder. AutoShare automatically acts upon detection of the
  362. D./X. UUCP pair of files by converting them into one properly formatted file sent
  363. to the MailShare Incoming Mail folder and finishes by deleting the UUCP pair of
  364. files.
  365.  
  366. The contents of the D. file is transferred directly to the data part of the new
  367. mail file; the resource part is updated based on the X. file (sender (appends the
  368. domain from the Bounce address) as well as (multiple) recipient(s)).
  369.  
  370. It is recommended that you choose to reduce the file sharing to include the two
  371. above folders (the inspool folder and the Filed Mail folder). The mail spooled by
  372. Eudora to the Filed Mail folder will stay there for a very brief moment and as
  373. such poses no major risk in terms of security. Access to the inspool folder may
  374. be adjusted to include the individual user only.
  375.  
  376. -----------------------------------------------------------------------------
  377.  
  378. II. How to install AutoShare
  379.  
  380. • Read the documentation
  381.  
  382. Please read this document in its entirety for further information. Also, make
  383. sure to have your Map Control Panel configured properly as well as MailShare
  384. fully set up and running.
  385.  
  386. If you prefer a quick start, you may want to start out focusing on the
  387. following, which is enclosed with the AutoShare software:
  388.  
  389.   -The Samples folder
  390.   -Jason Snell's AutoShare QuickStart Guide
  391.   -Once configured, use the Analysis tool
  392.  
  393. In any event, be sure that you are familar with MailShare.
  394.  
  395. • The AutoShare application
  396.  
  397. Assuming that you have already created a MailShare folder for the MailShare
  398. application, create now an AutoShare folder for the AutoShare application and
  399. put AutoShare inside.
  400.  
  401. • The Filed Mail folder
  402.  
  403. First of all, it is suggested that you start out creating a folder, e.g. Auto,
  404. inside the harddisk root folder for your AutoShare folders. Then create the Filed
  405. Mail folder (see Folders below) inside the Auto folder. As for MailShare, the Saved
  406. as files accounts must specify the Filed Mail folder.
  407.  
  408. • The Docs folder and files
  409.  
  410. Create a Docs folder inside Auto, then create the Docs/user subfolders, one per
  411. account; within each:
  412.     - create a Default (case-insensitive) document
  413.         - create an optional enclosure (Default.hqx)
  414.     - create alternate documents with names matching subjects
  415.         - create optional enclosures (above file name plus '.hqx')
  416.     (NOTE: the docs must be formatted using a hard return per line)
  417.  
  418. • If running a listserver
  419.  
  420. Create a special LS folder (inside the Auto folder) aimed at listserv
  421. mailing lists, which is specified by the LSFolder field in the AutoShare
  422. Preferences. As for MailShare, create 1. corresponding MailShare 'save as
  423. files' accounts ('<list>@<domain>') which point to the Filed Mail folder, and
  424. 2. two sets of corresponding MailShare 'mailing list' accounts
  425. ('<list>.m@<domain>' and '<list>.d@<domain>') and have them point to
  426. automatically created and updated .m and .d list files (based on the main list
  427. files) in the LS folder; these MailShare accounts make the AutoShare preview
  428. possible.
  429.  
  430. There are several benefits to the AutoShare preview: 1. the current archives
  431. file is updated automatically without any extra configuration, 2. a Reply-To
  432. e-mail header field indicating the list is inserted, and 3. the digest feature
  433. which automatically updates message (.m) and digest (.d) lists, based on the
  434. main list of subscribers.
  435.  
  436. Furthermore, the preview suppresses messages, which were meant to be sent to
  437. the listserv address, but mistakenly were sent to a list address; if the
  438. subject of a list contribution begins with a listserv command, the message will
  439. not be posted, but will be returned to the sender with a brief note added to
  440. the original contents of the message (if the listserver is configured to accept
  441. listserv commands in the first line(s) of the body, then the check will apply
  442. to both subject and the first line of the body).
  443.  
  444. Also, if you haven't subscribed to a list, but contributes anyway, a similar
  445. kind of action will be taken. A list is for subscribers only. Enclosures may be
  446. included with list contributions, but filtered away for the archives.
  447.  
  448. New documents in the Docs/autoshare folder must be named LIST, REVIEW, SUB,
  449. UNSUB, SET, INDEX, GET, WHICH, RELEASE and QUERY and include the /=list,
  450. /=review, /=sub, /=unsub, /=set, /=index, /=get, /=which, /=release and /=query
  451. token pairs respectively (don't forget the Default).
  452.  
  453. Furthermore, <command>.<list> documents in the Docs/autoshare folder override
  454. the default <command> documents. One example is SUB.FUN-L, which is used for
  455. users having subscribed to the FUN-L list.
  456.  
  457. For the listserver, create also an Archives folder (inside the Auto folder).
  458. Subfolders (named after the lists) inside the Archives folder must be created
  459. as well.
  460.  
  461. • The Filters folder
  462.  
  463. The filters feature is aimed at excluding addresses such as list addresses
  464. from receiving automated vacation notices. For more information, find the
  465. part entitled 'Filter definitions' below.
  466.  
  467. • The AutoShare preferences
  468.  
  469. Start up AutoShare on your MailShare server. From the Preferences menu, choose
  470. Miscellaneous; type in the administrator address (e.g. listmaster@yourdomain)
  471. and the bounce address (e.g. postmaster@yourdomain). From the Preferences menu,
  472. choose Folders and type in (or use the Select buttons for) the full path (with
  473. a trailing colon) of each of your newly created folders plus the MailShare
  474. Incoming Mail folder. Please note that all paths must begin with the startup
  475. volume of the server.
  476.  
  477. • Want to make it easy for yourself?
  478.  
  479. Use the System 7.5 NowMenus feature to get a clearer overview of your folders
  480. (or use the Now Utilities with earlier system versions); the documents may be
  481. opened directly from within the file hierarchy of the submenus.
  482.  
  483. Verification plus added overview is provided by the AutoShare Analysis tool,
  484. which is available from the Preferences menu. A file entitled 'AutoShare
  485. Analysis' will be created in the folder, in which the AutoShare software
  486. resides.
  487.  
  488. • That's about it
  489.  
  490. You're pretty much set up by now. Keep adding MailShare accounts as well as
  491. AutoShare subfolders and files as your needs grow. Keep your Auto folder and
  492. all of the subfolders clean; also, initial planning pays off later.
  493.  
  494. 1. Folders
  495.  
  496. This is the complete list of folders relating to AutoShare:
  497.  
  498. AutoShare (or similar)  = folder with AutoShare
  499. Filed Mail (or similar) = MailShare 1.0b8, 'Saved as files' folder
  500. Incoming Mail           = MailShare 1.0b8, 'Incoming Mail' folder
  501. Docs (or similar)       = folder with user named subfolders with text files
  502. LS (or similar)         = folder with listserv mailing lists
  503. Archives (or similar)   = folder with archive files
  504. Filters (or similar)    = folder with filter files
  505. Preferences(/AutoShare) = the System 7 savvy Preferences folder
  506.  
  507. 2. Files
  508.  
  509. This is the complete list of files relating to AutoShare:
  510.  
  511. AutoShare Documentation   = this document
  512. AutoShare Version History = versions (development, ...)
  513. AutoShare                 = the software
  514. AutoShare Preferences     = preferences file
  515. AutoShare Log             = log file
  516. AutoShare Hosts           = hosts file
  517. AutoShare Times           = times file
  518. Default etc               = return text file
  519. Default.hqx etc           = Binhex 4.0 enclosures
  520. Listserv list files       = MailShare mailing lists
  521. Archive files             = listserv list archives
  522. Filter files              = filter documents
  523.  
  524. 3. AutoShare Preferences
  525.  
  526. The AutoShare Preferences file is configured via the Preferences menu selections.
  527.  
  528. Each line consists of two tokens (a command and an option) separated by a
  529. delimiter (a space). There are 11 different commands:
  530.  
  531. AdminAddress  = e-mail address of AutoShare Administrator (log)
  532. BounceAddress = e-mail address of the bounce account (see below)
  533. Log           = Off, Always, Brief (default), Tech (see Logs below)
  534. Format        = (for the archives:) Text (default), HTML
  535. Bounce        = Off, On (default), Empty (see below)
  536.  
  537. FiledMail     = full path of folder (MailShare 1.0b8, 'Saved as files' folder)
  538. IncomingMail  = full path of folder (MailShare 1.0b8, 'Incoming Mail' folder)
  539. DocsFolder    = full path of folder with user named subfolders with text files
  540. LSFolder      = full path of folder with listserv mailing lists
  541. Archives      = full path of folder with archive files
  542. Filters       = full path of folder with filter files
  543.  
  544. 4. Subject based text files
  545.  
  546. The Default file and the subject based text files reside in the Docs/user (or
  547. similar) folders. Each token pair (a switch and a command) comes without any
  548. delimiter. There are 1 different token pair combinations:
  549.  
  550. /=original   = picks up the original message
  551.  
  552. Listserver only:
  553.  
  554. /=list       = displays the lists in the LS folder
  555. /=review     = lists the subscribers for a given list
  556. /=sub        = confirms the subscription of the user
  557. /=unsub      = confirms the cancelled subscription
  558. /=set        = updates various options:
  559.                  conceal: conceals the subscriber (review)
  560.                  nonconceal: makes the subscriber visible
  561.                  digest: one daily mail with all list messages
  562.                  nodigest: individual mail messages
  563.                  mail: you receive list mail
  564.                  nomail: subscribed, but no mail
  565.                  ack: you receive a list contribution copy
  566.                  noack: no acknowledgment contribution copy
  567. /=index      = lists the archive files for a list
  568. /=get        = returns a list archive file
  569. /=which      = informs you of the lists you are on
  570. /=release    = information about the listserver software
  571. /=query      = information about your subscription status
  572.  
  573. 5. E-mail header
  574.  
  575. AutoShare acknowledges the following fields in the e-mail header of the message
  576. being fetched from the Filed Mail folder:
  577.  
  578.      From:         the auto-response uses this for the To field
  579.      To:           the auto-response uses this for the From field
  580.      Subject:      transferred to the auto-response
  581.      Date:         the auto-response obtains current date and time
  582.      Reply-To:     used for filtering
  583.      Sender:       used for filtering
  584.      Mime-Version: if available, transferred to the auto-response
  585.  
  586. As a general rule, the e-mail header is kept separately from the "Save as
  587. files" 'STR ' (8192, From) and 'STR#' (8192, To) resources (which AutoShare swaps
  588. too). Rare exceptions occur; an example (involving MailShare more than AutoShare)
  589. is messages generated from a mailing list being put into the Filed Mail folder:
  590. the "To" in the e-mail header is the list address, while the "To" in the resource
  591. is the final recipient (relates to the archives issue).
  592.  
  593. 6. Bounce address
  594.  
  595. The bounce account serves tree purposes:
  596.      a. acting as the From address, when mailing the log to the Administrator
  597.         (whose account may belong to any server btw)
  598.      b. a (perhaps overkill) domain verification aimed at distinguishing files
  599.         in the Filed Mail folder (auto-responses vs archive updates)
  600.      c. acting as the bounce account. The implementation of the actual bounce
  601.         feature is optional; a separate set of radio buttons determines the
  602.         following:
  603.        OFF: the bounce address feature is not applied
  604.        ON: for all auto-responses and admin log mailings, the 'STR ' resource
  605.            will be updated as coming from the bounce account rather than the
  606.            auto-response account in question (no change in the e-mail header's
  607.            From field). This ensures that all messages, which bounce back to
  608.            your server, are sent to your bounce address (and this one only).
  609.            Furthermore, if your Administrator account resides on the server,
  610.            this address may be identical to the bounce address
  611.        EMPTY: You may want to eliminate any mail bouncing back to your server;
  612.               an empty string is assigned to the 'STR ' resource
  613.  
  614. 7. AutoShare Hosts definitions
  615.  
  616. The AutoShare Hosts file was added to ease the use of MailShare non-default
  617. domains with AutoShare. Assuming that the MailShare default domain is used with
  618. the AutoShare bounce address, the domains in the AutoShare Hosts file must
  619. match the remaining MailShare domains for list contributions to work properly.
  620.  
  621. You create the AutoShare Hosts text file in the AutoShare folder inside the
  622. System 7 savvy Preferences folder; type in one domain name per line. Verify
  623. the list of domains by running the AutoShare Analysis tool and viewing the
  624. AutoShare Analysis file; the bounce address is listed first followed by the
  625. domains in the hosts file.
  626.  
  627. 8. Filter definitions
  628.  
  629. The filtering applies to the five fields below in the e-mail header. It also
  630. applies to any header being one of the five. Below, the first
  631. column indicates which field is to be applied, and the second column lists how
  632. to begin a definition line; the rest of this line is a substring aimed at
  633. searching in the e-mail header line in question.
  634.  
  635.      From:       'From: '
  636.      To:         'To: '
  637.      Subject:    'Subject: '
  638.      Reply-To:   'Reply-To: '
  639.      Sender:     'Sender: '
  640.      Any Header: ''
  641.  
  642.      If the definition line
  643. From: qualcomm
  644.      is applied to the e-mail header line
  645. From: majordomo@qualcomm.com
  646.      then majordomo@qualcomm.com will receive no vacation notices.
  647.  
  648.      The definition line
  649. qualcomm
  650.      applies to all five fields and respective e-mail header lines.
  651.  
  652. If a '*****' (5*) line is added to the end of the file, the one vacation
  653. notice only feature is enabled. AutoShare will automatically append new
  654. addresses to the file, whenever a message is received from a new sender.
  655.  
  656. Examples:
  657.  
  658. a. Simple filters file:
  659.  
  660. qualcomm
  661. yalevm.cis.yale.edu
  662.  
  663. b. The one vacation notice only feature added:
  664.  
  665. qualcomm
  666. yalevm.cis.yale.edu
  667. *****
  668.  
  669. When user@domain mails you, it will look like this:
  670.  
  671. qualcomm
  672. yalevm.cis.yale.edu
  673. *****
  674. user@domain
  675.  
  676. And later:
  677.  
  678. qualcomm
  679. yalevm.cis.yale.edu
  680. *****
  681. user@domain
  682. user2@domain2
  683.  
  684. Remember to clear and move the file, when you return!
  685.  
  686. 9. Logs
  687.  
  688. You may configure AutoShare for various amounts of log information:
  689.  
  690.      Off    = no logging
  691.      Always = important messages that are always logged (unless Off)
  692.      Brief  = a single line per transaction
  693.      Tech   = detailed information per transaction
  694.  
  695. Logs are automatically being mailed to the AutoShare administrator and
  696. initialized at scheduled times configured in the Times dialog box (from the
  697. Preferences menu, choose the Times menu item). The scheduled times for the
  698. digests are configured in the dialog box as well; choose digests from the
  699. pop-up menu at the top.
  700.  
  701. You may schedule the times for a particular interval of days and within the
  702. day a specific time. If either 'every <number> days' or 'at <time>' has changed
  703. and you press the OK button, the new settings take effect immediately; you may
  704. update the settings for both logs and digests with a combined single OK.
  705.  
  706. If the settings have just been updated, 'every <number> days' implies that the
  707. first log or digest will be mailed in <number> of days (if set for 1 day, then
  708. tomorrow). If you want it to happen later the same day of the configuration,
  709. click at that time in the Now checkbox without altering any other settings; you
  710. may use the Now checkbox whenever you need more frequently mailed logs or
  711. digests in a temporary situation.
  712.  
  713. -----------------------------------------------------------------------------
  714.  
  715. III. Running AutoShare
  716.  
  717. All you need to do to run AutoShare is launch the application (you have probably
  718. already done so configuring AutoShare Preferences). As long as AutoShare is running
  719. with MailShare, things should work well. 
  720.  
  721. -----------------------------------------------------------------------------
  722.  
  723. IV. AutoShare the listserv way
  724.  
  725. The listserv commands appear in special command lines (either the subject or
  726. the first line(s) of the body), which trigger certain events. Other commands,
  727. e.g. including HELP, can be made available as well of course.
  728.  
  729. 1. Commands
  730.  
  731. The command is the first word in the body/subject line:
  732.  
  733.      LIST
  734.      REVIEW <list>
  735.      SUB <list> <name>
  736.      UNSUB <list>
  737.      SET <list> <option>
  738.      INDEX <list>
  739.      GET <list> <file>
  740.      WHICH
  741.      RELEASE
  742.      QUERY <list>
  743.      
  744. Several alias commands are available as well:
  745.  
  746.      SUB:    subscribe
  747.      UNSUB:  unsubscribe, signoff
  748.      LIST:   lists
  749.      REVIEW: rev, recipients, who
  750.      INDEX:  ind
  751.      GET:    send
  752.  
  753. There is no HELP command, but it is surely okay to create a doc called HELP.
  754.  
  755. 2. Multi-command mail
  756.  
  757. If your listserver has been configured to accept command requests in the body,
  758. the subscriber may include several such requests in one and the same mail.
  759. When 1. a body line is found which does not begin with a valid command, or 2.
  760. there are no more body lines, AutoShare will stop processing the mail.
  761.  
  762. sub fun-l Mikael Hansen
  763. set fun-l ack
  764. set fun-l conceal
  765. query fun-l
  766. review fun-l
  767. bla bla
  768. list
  769.  
  770. In the above example, the first five command lines will be processed and
  771. returned as five separate mails; the sixth line is not valid (and will generate
  772. no response mail), and so the processing halts.
  773.  
  774. 3. Lists
  775.  
  776.      The format per line is:
  777. <user>@<domain> (<optional comment>)
  778.  
  779.      or phrased differently:
  780. <address> (<name>)
  781.  
  782.      The reduced form is okay as well:
  783. <address>
  784.  
  785.      The expanded form includes listserv status codes:
  786. <address> (<name>..<codes>)
  787.  
  788.      If concealed, then:
  789. <address> (<name>..0)
  790.  
  791.      or simply:
  792. <address> (..0)
  793.  
  794. Listserv status codes supported by AutoShare are:
  795.  
  796.      0: concealed (if visible, then simply no 0)
  797.      1: digest (if messages, then simply no 1)
  798.      2: no mail (if mail, then simply no 2)
  799.      3: acknowledgement (if not, then simply no 3)
  800.  
  801. Examples:
  802.  
  803.      meh@admin2.kb.bib.dk (Mikael Hansen)
  804.      meh@admin2.kb.bib.dk
  805.      meh@admin2.kb.bib.dk (Mikael Hansen..0)
  806.      meh@admin2.kb.bib.dk (..0)
  807.      meh@admin2.kb.bib.dk (Mikael Hansen..012)
  808.      meh@admin2.kb.bib.dk (..0123)
  809.  
  810. (the codes 4 and upwards have not yet been implemented)
  811.  
  812. -----------------------------------------------------------------------------
  813.  
  814. V. Loop detection and elimination
  815.  
  816. One of the worst things that can happen to a list on your listserver is to have
  817. a mailing loop develop. AutoShare takes several precautions against this type
  818. of unpleasant events.
  819.  
  820. First of all, it is important to understand the difference between 'actual' and
  821. 'header' addresses: while the header addresses reside in the email header of the
  822. message, the actual addresses are found in the resource part of the message file,
  823. namely the 'STR ' (8192, From) and the 'STR#' (8192, To) resources (in the
  824. world of UUCP, the D. file reflects the data part, whereas the X. file reflects
  825. the resource part).
  826.  
  827. Taking advantage of the bounce feature (either 'On' or 'Empty' is an important
  828. step towards limiting potential problems with loops (circular references).
  829. For all auto-responses and admin log mailings, the 'STR ' resource will be
  830. updated as coming from the bounce account rather than the auto-response account
  831. in question (no change in the e-mail header's From field). This ensures that
  832. all messages, which bounce back to your server, are sent to your bounce address
  833. (and this one only).
  834.  
  835. It is recommended that you configure your AutoShare preferences, so that the
  836. Admin address is set for a Listmaster account and the Bounce address is set for
  837. the Postmaster account. It certainly does not have to be so, but it does serve
  838. as an excellent and easy-to-remember solution.
  839.  
  840. The following examples illustrate various loop situations, in which actual
  841. addresses tend to differ from header addresses.
  842.  
  843. a. Your basic bounce
  844.  
  845. The listserver (in fact any AutoShare account) returns an auto-response to a
  846. user, whose mail system is malfunctioning at the time. The message bounces back
  847. to the mail system of your listserver, but although the listserv account is
  848. listed in the To field of the e-mail header, the bounce account receives the
  849. mail: it is the actual recipient because it was originally the actual sender.
  850.  
  851. b. Mail to the same account
  852.  
  853. You have enabled the vacation notice feature; in terms of MailShare, this means
  854. that you have turned on 'Save as files' with the 'Keep' button checked.
  855. After having sent the message, your account receives the message; furthermore,
  856. the other copy is put in the Filed Mail folder: AutoShare compares the To and
  857. From resources, and since they are identical, no vacation notice is triggered.
  858. This feature applies mostly, when the bounce feature is not used.
  859.  
  860. c. Incoming list mail
  861.  
  862. An example involving not AutoShare, but MailShare only is messages generated
  863. from a mailing list being put into the Filed Mail folder: the To in the e-mail
  864. header is the list address, while the To in the resource is the final recipient.
  865. While this is not a loop issue per se, it illustrates the difference between
  866. the two types of To addresses (this distinction relates to the feeding of the
  867. archives thru the use of the 'Save as files' Archives account, which AutoShare
  868. benefits from).
  869.  
  870. d. NewsWatcher
  871.  
  872. You have enabled the vacation notice feature and then press Command-Option-L
  873. in NewsWatcher, which mails you the news article. The actual sender is you, not
  874. the person who posted the article, so there is no problem.
  875.  
  876. e. Mail to Cc recipient
  877.  
  878. This example affects the e-mail header only, but I'll include it anyway. An
  879. AutoShare account receives a message, and the address of this account is placed
  880. in the Cc field. In this case, AutoShare doesn't use the address in the To field
  881. when creating the From address for the auto-response message; instead the newly
  882. created From resource is inserted into the From field in the e-mail header.
  883.  
  884. -----------------------------------------------------------------------------
  885.  
  886. VI. And then ...
  887.  
  888. By now, you should be able to utilize AutoShare in full. My best advice to you is
  889. to keep the folders clean and otherwise be aware of the overall structure. If
  890. done this way, it should appear simple to carry out. If not, you can get into a
  891. mess really quickly. Hint: peek at the Samples folder enclosed with the AutoShare
  892. software.
  893.  
  894. Feel free to test a standard AutoShare auto-answering service by writing to
  895. finger@admin2.kb.bib.dk. Also, I have an AutoShare listserver running using
  896. autoshare@admin2.kb.bib.dk. Both accounts run without any problems - mostly,
  897. that is :-) http://www2.kb.bib.dk/Staff/meh/AutoShare/AutoShare.html is the web
  898. site for AutoShare.
  899.  
  900. The AutoShare beta list took off on March 16 1995; as of June 7 1995 (shortly
  901. before releasing 1.0 final), the list had 280 subscribers. If you subscribe
  902. to the beta list at autoshare@admin2.kb.bib.dk (put 'sub autoshare.beta <name>')
  903. in the first line of the body), you will receive instructions on how to obtain
  904. your current beta copy of the AutoShare beta software. General information is
  905. available at autoshare.info@admin2.kb.bib.dk.
  906.  
  907. The officially released version (currently 1.0) of AutoShare is freeware and
  908. can be downloaded from your local Info-Mac mirror site (in the directory
  909. comm/tcp/mail).
  910.  
  911. Version 1.1 is aimed at an enhanced user interface and list-specific issues.
  912.  
  913. Have fun!
  914.  
  915. -----------------------------------------------------------------------------
  916.  
  917. VII. Undocumented features
  918.  
  919. The features below are considered undocumented, although they appear in this
  920. AutoShare documentation. They may some day be upgraded to documented features 
  921. or simply go away.
  922.  
  923. To disable having just subscribers post to the lists, create an empty file
  924. entitled 'all may contribute' in the same folder as the AutoShare software.
  925.  
  926. To use 'listserv@' (rather than 'autoshare@') as the listserver account,
  927. create an empty file entitled 'use listserv' in the same folder as the
  928. AutoShare software.
  929.  
  930. -----------------------------------------------------------------------------
  931.  
  932. VIII. The small print
  933.  
  934. AutoShare, a freeware MailShare utility
  935. An auto-responder and listserver for the Macintosh
  936.  
  937. Officially released versions (Info-Mac and similar sites): you may distribute
  938. this program along with the complete documentation as long as you don't charge
  939. for it.
  940.  
  941. Beta versions and similar (my AutoShare beta list sites): to be used by no one
  942. else than the fine individuals on my non-public beta list; anyone may subscribe to
  943. the beta list, but beta versions of AutoShare are not to be discussed outside
  944. the beta list. The beta software and the beta docs are not public information.
  945.  
  946. AutoShare is a personal project of Mikael Hansen in his free time and in *no*
  947. way relates to his work as such.
  948.  
  949. Mikael Hansen accepts *no* responsibility for the use of AutoShare.
  950.  
  951. -----------------------------------------------------------------------------
  952.