home *** CD-ROM | disk | FTP | other *** search
/ High Voltage Shareware / high1.zip / high1 / DIR4 / XMAIL100.ZIP / XMAIL.DOC < prev    next >
Text File  |  1993-12-07  |  37KB  |  1,162 lines

  1.  
  2.  
  3.         xMail 1.00
  4.  
  5.         Echomail Processor for Hudson, *.MSG,
  6.         Squish and JAM message base.
  7.  
  8.         (c) 1990-1993  Roger Kirchhoff & Stefan Graf
  9.         xMail H.Q. BBS +49-2351-786580
  10.         All rights reserved
  11.  
  12.  
  13.  
  14.         FEATURES
  15.         ========
  16.  
  17.         Supports Hudson, Squish, *.MSG and JAM.
  18.  
  19.         Multiline tossing.
  20.  
  21.         NETWORK and multiline support with advanced file and
  22.         record locking abilities lets you run a multiple node
  23.         BBS and process mail while users are online.
  24.  
  25.         xMail can toss on multiple lines at the same time.
  26.  
  27.         Supports Cost Sharing System for Echomail.
  28.  
  29.         Forward echo area requests
  30.  
  31.         Automatic creation of new echos with alert messages to
  32.         Sysop and in an echo, fully configurable for every
  33.         node
  34.  
  35.         Message Forwarding and Readdressing
  36.  
  37.         Post textfiles
  38.  
  39.         Free definable textfiles for all messages created by xMail
  40.         with powerful macro support
  41.  
  42.         Works with almost any BBS system
  43.  
  44.         Works with FrontDoor, DBridge and Binkley!
  45.  
  46.         Advanced Security options for both mail packet
  47.         checking and echoarea/node control
  48.  
  49.         Mixed Message base styles (Hudson, *.MSG, Squish + JAM)
  50.         configurable for every echo !
  51.  
  52.         Conference Support for easy usage in multiple
  53.         network environments (Fido, SigNet etc.)
  54.         Up to 50 conferences.
  55.  
  56.         Comfortable FULLSCREEN SETUP program lets you
  57.         change your configuration in seconds
  58.  
  59.         Context sensitive Help System in xMail's
  60.         setup program XMSETUP
  61.  
  62.         Supports all compression formats and allows you to
  63.         add support for ANY new packer in the future!!
  64.  
  65.         Built in Areafix can RESCAN Areas
  66.  
  67.         Configurable Areafix messages
  68.  
  69.         Allows unlimited number of netmail areas in your BBS
  70.         for special addresses and user groups
  71.  
  72.         Advanced dupe checking, stores up to 100.000 dupes
  73.  
  74.         All mail processing in one run: Import, Export,
  75.         Reply-Linking and Areafix
  76.  
  77.         Multiple Logfiles for Areafix and Statistics
  78.  
  79.         Supports 1000 Message Areas
  80.  
  81.         and many, many more !!!
  82.     
  83.  
  84.  
  85.                         FILES WITH xMail
  86.                         ================
  87.  
  88. XM.EXE                  Main executable program
  89. XM.OVR                  Overlay file for xMail
  90. XMAIL.CFG               Sample configuration file.
  91.                         This is a plain ASCII file which contains all
  92.                         information about your system. You may use any
  93.                         ASCII editor or the built in editor in XMSETUP
  94.                         to edit it to your needs.
  95. COMPLETE.CFG            Sample XMAIL.CFG configuration file which
  96.                         contains all possible config statements and
  97.                         their descriptions. Please read this file
  98.                         carefully to get to knoww all xMail features.
  99. WHATSNEW.DOC            What's new with xMail 1.00 and XMSETUP
  100. XMSETUP.EXE             xMail's fullscreen setup program
  101. XMSETUP.OVR             Overlay file for XMSETUP
  102. XMSETUP.HLP             XMSETUP's help file (english).
  103. XMSETUP.GER             XMSETUP's help file (German)
  104.                         Rename XMSETUP.GER to XMSETUP.HLP
  105.                         to use german language online help.
  106. XMAIL.DOC               This document file
  107. 110TO111.EXE            Conversion Program to Update Data Files
  108.                         from RA-Echo 1.10 to xMail 1.00 specs.
  109.  
  110. Files created by either xMail or XMSETUP:
  111.  
  112. NODE.XM                 Node database
  113. AREAS.XM                Echo configuration
  114. CONFNAME.XM             Conference descriptions
  115. LINKS.XM                Reply-Links information
  116.                         If you renumber your message base you
  117.                         have to delete the file LINKS.XM which
  118.                         contains the info about reply linking. xMail
  119.                         will then rebuild it the next time you start it.
  120. DUPES.XM                Info for dupe checker
  121. LASTEXP.XM              Last exported message in *.MSG directory
  122.  
  123.  
  124.                         LOGFILES
  125.                         ========
  126.  
  127. xMail's logfiles may have any name (see XMAIL.CFG),        
  128. defaults are the following:
  129.  
  130. XMAIL.LOG            General information and errors
  131.  
  132. AREAFIX.LOG            All Areafix events
  133.  
  134. STATIST.LOG            Import & Export statistics
  135.  
  136.  
  137.  
  138.                         GETTING STARTED
  139.                         ===============
  140.  
  141. 1 - Copy all files to your xMail directory
  142.  
  143. 2 - If you have a valid xMail key rename the keyfile to XMAIL.KEY
  144.  
  145. 3 - Start XMSETUP
  146.  
  147.     NOTE: If you are upgrading from RA-Echo version 1.10, be sure
  148.     to use the 110TO111.EXE conversion program before
  149.     running XMSETUP.
  150.     
  151. 4 - Edit XMAIL.CFG to your needs (see comments in COMPLETE.CFG)
  152.  
  153.     NOTE: There are many feature of XMAIL that are not
  154.     specifically addressed in this document, but in the
  155.     XMAIL.CFG file. Please read XMAIL.CFG. I also
  156.     highly recommend to use the XMAIL.CFG from the
  157.     distribution package and edit it to your needs as
  158.     there are a lot of new keywords and features!
  159.  
  160. 5 - Enter all echos (You may enter these manually or use
  161.     XMAIL's import feature.)
  162.  
  163. 6 - Enter all nodes and configure them accordingly
  164.  
  165. 7 - Make sure that you have your FILES=45 or more.
  166.  
  167. 8 - Reboot your system so that the new CONFIG.SYS is used.
  168.  
  169.  
  170.  
  171.                         SYNTAX and PARAMETERS
  172.                         =====================
  173.  
  174. Commands
  175. --------
  176.  
  177. XM IMPORT <switches>
  178.  
  179. This command will tell xMail to import received
  180. mail to the messagebase and export them to your
  181. downlinks.
  182.  
  183. (see Command Line Switches below)
  184.  
  185.  
  186.  
  187. XM EXPORT <switches>
  188.  
  189. This command tells xMail to scan the messagebase
  190. and export new locally entered mail.
  191.  
  192. (see Command Line Switches below)
  193.  
  194. On Export you can declare what Areas have to
  195. be scanned by giving the name of a file which contains
  196. a list of the areas as 2nd parameter with 
  197. '@<FileName>'. Some systems automatically create 
  198. this file, and exporting can be much faster if you use this.
  199.  
  200. Example:
  201.  
  202. XM EXPORT /Q+ /V- /L- @EXPORT.BBS
  203.  
  204. If no name is specified all areas will be scanned.
  205. This does of course not affect the message base.
  206.  
  207.  
  208.  
  209. XM DELETEAREA <AREANAME,...>
  210.         
  211. This command will remove the echos. Each area 
  212. must be separated by a comma ','.  xMail will
  213. generate an Areafix Message to your UPLINK to 
  214. terminate the feed.  All DOWNLINKS will be sent 
  215. a message informing them of the change. The text
  216. to be sent is configurable in XMAIL.CFG under
  217. the keyword ECHOCANCELTEXT.  Areafix macros are
  218. available including '&Z' for the AreaName.
  219.  
  220. e.g. EchoCancelText  Area &Z was deleted by Sysop.
  221.  
  222. NOTE: Areas deleted with DELETEAREA will not be
  223. accepted as new areas for 10 days.  The reason for
  224. this is quite simple: If you have deleted an Echo,
  225. your next poll will usually still contain some
  226. messages for that area, and xMail would try to
  227. add that as a new area. 
  228.         
  229.  
  230.  
  231. XM CLEANUP  <Number of Days>
  232.  
  233. This command will remove all Pass-Thru areas that
  234. do not have mail flow for <Number of Days> days.
  235. CLEANUP will also remove Pass-Thru areas without
  236. downlinks.  xMail will generate an Areafix
  237. Message to your uplink to terminate the feed.
  238.         
  239. All DOWNLINKS will be sent a message informing them
  240. of the change. The text to be sent is configurable
  241. in XMAIL.CFG under the keyword ECHOCANCELTEXT.
  242. Areafix macros are available including '&Z' for the
  243. areaname.
  244.  
  245.  
  246.  
  247. XM POST [Filename] [Areaname] [Subject] <NodeAdr|NodeName>
  248.              
  249. This command allows you to post a textfile into 
  250. ECHO or NETMAIL areas.
  251.  
  252. Filename:     Name of the text file to be imported.
  253. Areaname:     Area that text shall be posted in.
  254.                 If  'NETMAIL', then Netmail will be created.
  255. Subject  :     Subject of the message.
  256. NodeAdr  :     Unlimited number of node addresses for
  257.         NETMAIL posts.  Wildcards ('ALL' or '*').
  258.         Receivers of NETMAIL must be in XMAIL's
  259.         Nodefile (NODES.XM).
  260. NodeName:    If you don't specify a nodenumber but a
  261.                 name xMail creates an mail to this
  262.         name. Include the name in "".
  263.  
  264. Examples:
  265.  
  266. XM POST C:\NEWS.ASC "NETMAIL" "News from your boss" 2:245/4.*
  267. posts a textfile to all points as netmail.
  268.  
  269. XM POST C:\RA\NEWUSER.ASW "PRIVATE POST" "Ein neuer User..." "Klaus Roessler"
  270. posts the RA questionaire answer file as a private message to my Co-Sysop.
  271.  
  272.  
  273. XM NOTIFY
  274.  
  275. This command tells xMail to create a notify message
  276. for selected nodes with an actual list of all ordered
  277. echos. More link information can be added with the 
  278. notify-message configuration parameters. (See Areafix)
  279. You must have set the Node's 'Send Notify Message'
  280. switch to 'Yes' to let him receive the message. Same 
  281. with QUERY and FILEQUERY commands. You may declare nodes
  282. to receive such a message in the command line 
  283. (for example 'xMail NOTIFY 2:All') and use the
  284. wildcards 'All' or '*' to include nodes.
  285.         
  286.  
  287.  
  288. XM QUERY
  289.  
  290. This command tells xMail to send a message to selected
  291. nodes to inform them what areas are available on your 
  292. system.
  293.  
  294.  
  295.  
  296. XM AREAFIX
  297.  
  298. This command tells xMail to process Areafix messages
  299. only. NO Import is done! xMail only scans for netmail
  300. addressed to Areafix and processes them. 
  301. See AREAFIX section for details.
  302.  
  303.  
  304.  
  305. XM PACK
  306.  
  307. This command tells xMail to pack netmail. Please
  308. read the PACK NETMAIL section of this manual for more
  309. information.
  310.  
  311. You may optionally specify a route file in the command-
  312. line with @<FILENAME>. This route file like a 'batch'
  313. of command lines for use with PACK.  
  314.         
  315. Use the command xMail @<FILENAME> where the <FILENAME>
  316. is the route file.
  317.         
  318. Example:  ROUTE.XM
  319.  
  320. 245/4.all
  321. 2:245/all VIA 245/31 /NC
  322. 2:all VIA 245/0 /NC
  323. 1:all VIA 2:2/0 /NC
  324.  
  325. For this, we would use: xMail PACK @ROUTE.XM
  326.  
  327.  
  328.  
  329. XM REATTACH
  330.         
  331. This command tells xMail to scan your arcmail outbound
  332. directory and check if there are file attach messages for
  333. every packet. If missing, new ones will be created. This
  334. should prevent a packet from not being sent if the 
  335.  file attach message gets lost. Note: Use REATTACH /Y0
  336. to reattach arcmail packets on ALL lines.
  337.  
  338.  
  339.  
  340. XM CHECKSYSTEM
  341.  
  342. Check if echos requested from an uplink did arrive within
  343. the last 14 days. If not the requester will be notified
  344. that the requested echo is not available.
  345.  
  346.  
  347.  
  348. XM REIMPORT
  349.  
  350. xMail is now able to reimport dupes and illegal messages!
  351. You can select if the messages shall also get exported and 
  352. pass several area names or *.MSG directories.
  353.  
  354. Example: xMail REIMPORT DUPE BAD E:\FD\MESSAGE\ILLEGAL
  355.  
  356. The areas DUPE and BAD and the MSG directory 
  357. E:\FD\MESSAGE\ILLEGAL will be reimported.
  358.  
  359. XM REIMPORT NEWMAIL
  360.  
  361. All msgs from the newmail area will be reimported. This might be
  362. useful if you don't want new echos to be automatically created but
  363. also don't want to loose the messages. Reimported msgs get deleted.
  364.  
  365. If the messages have to be exported to downlinks also add a '+' in
  366. front of the name. Example: xMail REIMPORT +ILLEGAL
  367.  
  368.  
  369.  
  370. XMSETUP FD        Create FOLDER.FD file from xMail echo setup.
  371.  
  372. XMSETUP RA        Create RemoteAccess 1.1x compatible MESSAGES.RA.
  373.  
  374. XMSETUP RA200     Create RemoteAccess 2.0x compatible MESSAGES.RA.
  375.  
  376.                   The environment variables RA and FD have to point
  377.                   to the directory where the files shall be created.
  378.  
  379.  
  380.  
  381.                         Command Line Switches
  382.                         =====================
  383.  
  384. Use can use several command line switches to toggle some
  385. of xMail's features. '+' switches on and '-' off.
  386.  
  387.  
  388. General Switches
  389.         
  390.  
  391. /Y..    Line number
  392.  
  393.     Example:
  394.     XM IMPORT /Y1
  395.     Import on line 1
  396.  
  397.     If you don't define the line number xMail will automatically
  398.     use the first free line number.
  399.     Using line 0 will lock all other lines.
  400.         Use this for maintenance tasks like CLEANUP etc.
  401.  
  402. /L+-    Reply-Linking
  403.  
  404.     You can tell xMail to automatically Reply-Link messages
  405.     as they are being imported with the /L+ switch.    
  406.  
  407.     Default: /L-     (OFF)
  408.  
  409.  
  410. /N+-    Network and Multiline Support
  411.  
  412.     With this switch you can tell xMail to work in
  413.     NETWORK mode and to turn on all the record locking schemes    
  414.         If Novell or Share is loaded xMail will automatically
  415.         switch to network mode.
  416.  
  417.     Default: /N-    (OFF)    
  418.  
  419.  
  420. /V+-    Screen Output
  421.  
  422.     You may suppress screen output when IMPORTING/EXPORTING
  423.     with the /V- switch.
  424.  
  425.  
  426. /D+-    Dupe-Checking
  427.  
  428.     You can suppress dupe checking with the /D- switch.
  429.  
  430.     Default: /D+    (ON)
  431.  
  432. /E+-    EMS Usage
  433.  
  434.     You can suppress the use of EMS with /E-
  435.  
  436.     Default: /E+    (ON)
  437.  
  438. /Q+-    Quick-Scan on EXPORT
  439.  
  440.     In Quick-Mode, only messages after the last exported
  441.     message will be exported. Otherwise xMail will
  442.     scan the whole message base. In /Q- mode you can be
  443.     sure that never a message will remain unexported,
  444.     but Quick-Scan mode is *much* faster. If you use
  445.     Quick-Scan mode, xMail creates a file named
  446.     EXPMARK.XM with the data of the last exported
  447.     message. xMail will recognise if you have purged
  448.     your base in the meantime and then scan the whole
  449.     base no matter if Quick-Scan is enabled.
  450.  
  451.     Default: /Q+    (ON)
  452.  
  453. /S+-    Save Mode for all file handling.
  454.               
  455.     If On, all files and the message base will be
  456.         flushed to disk after every write operation. If
  457.         your system crashes all files are saved, but this
  458.         will SLOW DOWN xMail VERY MUCH, so usually this
  459.         will not be necessary.
  460.  
  461.     Default: /S-    (OFF)
  462.  
  463. /R+-    Force Mailer Rescan.
  464.  
  465.         If xMail writes a netmail to your netmail directory
  466.     it can also create a file to force your mailer to rescan
  467.     your netmail directory.
  468.  
  469.         FDRESCAN.NOW for FrontDoor
  470.     DBRIDGE.RSN  for D'Bridge
  471.  
  472.         Default: /R+    (ON)
  473.  
  474. /A+-    Process Areafix Messages.
  475.               
  476.         If /A-, xMail will not process any inbound messages
  477.         to Areafix.
  478.  
  479.     Default: /A+    (ON)
  480.  
  481. /B+-    Process/Import NETMAIL
  482.           
  483.     If /B- suppresses processing and importing of Netmail
  484.  
  485.         Default: /B+    (ON)
  486.  
  487. /G+-    Ignore MSGINFO.XM
  488.  
  489.         If /G+, xMail will not consult MSGINFO.XM.
  490.  
  491.         Default: /G-      (OFF)
  492.  
  493. /C    Use Different Configfile.
  494.  
  495.     /C<filename> is the name of the config file that you
  496.         want xMail to use. This makes it possible to operate
  497.     with different configurations.
  498.  
  499.         Default: /CxMail.CFG
  500.  
  501. /I+-    Import *.PKT from inbound directory.
  502.  
  503.         Default: /I+      (ON)
  504.  
  505.  
  506. /UH     The Hudson base will not be scanned
  507.  
  508. /UM     *.MSG areas will not be scanned
  509.  
  510. /US     Squish areas will not be scanned
  511.  
  512. /UJ     Jam areas will not be scanned
  513.  
  514.  
  515.                         Security Switches
  516.                         =================
  517.  
  518. /O+-    Security check for inbound Arcmail packets.
  519.               
  520.     If /O-, nodes can send arcmail in Areas they are not
  521.         qualified for.
  522.  
  523.         Default: /O+    (ON)
  524.  
  525.  
  526. /P+-    This is the most important security switch. If a
  527.         sender of an arcmail packet is not in your nodefile
  528.         xMail will NOT process the packet. You can switch
  529.         this check off with /P-. CAUTION: If you do this
  530.         anyone will be able to send you arcmail (including
  531.         potential arcmail bombs.)
  532.  
  533.         Default: /P+    (ON)
  534.  
  535.  
  536.                         COMMAND LINE EXAMPLES
  537.                         =====================
  538.  
  539. xMail IMPORT /L+ /D-
  540. Import mail with reply linking ON and dupe checking OFF.
  541.  
  542. xMail EXPORT /Q-
  543. Export mail from your system and disable Quick-Export.
  544.  
  545. xMail NOTIFY
  546. Create a notify netmail for every system in your nodefile
  547. that has set the 'Send Notify Message' in XMSETUP to
  548. 'Yes'.
  549.  
  550. xMail NOTIFY 245/4
  551. Create a notify netmail only for 245/4
  552.  
  553. xMail NOTIFY 245/4.ALL (or xMail NOTIFY 245/4.*)
  554. Create notify netmail for all points of 245/4
  555.  
  556. xMail QUERY 2:*
  557. Create Query netmail for all nodes in zone 2.
  558.  
  559. xMail PACK @ROUTE.XM
  560. Pack netmail with routing as defined in ROUTE.XM
  561.  
  562.  
  563. All switches are optional.
  564.  
  565.  
  566.  
  567.                         IMPORT
  568.                         ======
  569.  
  570. If you start xMail with the IMPORT parameter, all arcmail
  571. packets get unpacked in order of their date of creation. 
  572.  
  573. The echomail then gets imported into the base and/or directories
  574. and exported to the nodes.
  575.  
  576. During the import xMail shows you the area of the message
  577. currently being processed and some addition info:
  578.  
  579. l    Reply link message
  580. s    Save message to Hudson base
  581. q    Save message to squish base
  582. j    Save message to JAM base
  583. w    Write Message (*.MSG)
  584. e    Export to node
  585. c       Create new area
  586. d    Duplicate message found
  587. i    Illegal message
  588.  
  589.  
  590. After this has been completed, the netmail directory is scanned
  591. for new messages to your system. If present, they will be imported
  592. to the netmail area with the nodenumber of the message.
  593.  
  594.  
  595.  
  596.                         EXPORT
  597.                         ======
  598.  
  599. On EXPORT, all new messages entered on your system (which
  600. carry the 'local' bit) will get exported (simple, huh?).
  601.  
  602. To increase export speed you can tell xMail which areas have
  603. to be exported by defining an ASCII file which contains the
  604. area names that have to be processed:
  605.  
  606. XM EXPORT @<FileName>
  607.  
  608. <FileName> has to be a plain ASCII file which contains
  609. one area name per line. Each line must be terminated
  610. by a CR/LF.
  611.  
  612.  
  613.  
  614.                         PACK
  615.                         ====
  616.  
  617. xMail can pack netmail. You can use several keywords
  618. and command line switches to tell xMail where netmail
  619. has to go.
  620.  
  621. Call xMail with the PACK parameter and a list of the
  622. nodes whose netmail shall get packed, followed by 'VIA'
  623. the node that you want these netmails to be sent to.
  624. You may use the 'All' or '*' wildcard for more general
  625. processing.
  626.  
  627. You may also use the following switches to exclude some groups
  628. of netmail from routing:
  629.  
  630. /NC       Crash-Mail will NOT be routed
  631. /NI       In-Transit-Mail will NOT be routed
  632. /NL       Locally created Mail will NOT be routed
  633. /NH       Mail with Hold-Status will NOT be routed
  634. /ND       Omit packing of mail with Direct flag
  635.     on Binkley systems
  636. /RD     Direct netmail will be routed
  637. /R[x]   Toggle default netmail routing
  638.  
  639. Examples:
  640.  
  641. XM PACK 2:ALL VIA 2:245/31 /NC
  642. Send all netmail for zone 2 except crashmail to 2:245/31
  643.  
  644. XM PACK 2:245/4.All
  645. Pack netmail to the points
  646.  
  647. XM PACK * VIA 245/4 /RD
  648. Direct mail will be packed
  649.  
  650. All PACK commands can be put into one route file.
  651. You can specify the route file in the command line with
  652. @filename. The route file is built up in the same way as
  653. command lines.
  654.  
  655. Example:  ROUTE.XM
  656. 245/4.all
  657. 2:245/all VIA 245/31 /NC
  658. 2:all VIA 245/0 /NC
  659. 1:all VIA 2:2/0 /NC
  660.  
  661. ... and the command line you call xMail with:
  662.  
  663. xMail PACK @ROUTE.XM
  664.  
  665.  
  666.  
  667.                         ECHOS
  668.                         =====
  669.  
  670. The file AREAS.XM contains the information about all echomail
  671. areas on your system. Each area has a number from 1 to 1000 and
  672. can be imported to *.MSG, Hudson Base, Squish base or JAM base.
  673. Every echo can also get switched to PassThru which means the
  674. echo is not imported to any local message base but only forwarded
  675. to downlinks. Hudson areas may be hold in areas 1-200.
  676.  
  677. Please refer to XMSETUP's Online Help for more information.
  678.  
  679.  
  680.  
  681.                         NODES
  682.                         =====
  683.  
  684. The file NODE.XM contains the information about the connected
  685. nodes. You have to enter at least one node, your uplink, to make
  686. xMail work. Please refer to XMSETUP's Online Help for more 
  687. information.
  688.  
  689.  
  690.  
  691.                         AREAFIX
  692.                         =======
  693.  
  694. xMail's Areafix can handle both the original Areafix
  695. (by Greg Dawson) style commands with the switches in the
  696. subject line and Tosscan (by J. Homrighausen) style commands 
  697. with % in the messagetext.
  698.  
  699. Additionally Areafix can rescan areas if you add -R
  700. after the area name.
  701.  
  702. AREAFIX.HLP must be in your xMail directory!
  703.  
  704.  
  705. AREAFIX COMMANDS
  706.             
  707. %HELP:            Request a HELP message.
  708. [+]<AREANAME>           Turn On/Request an area.
  709.  -<AREANAME>            Turn Off/Disconnect an area
  710. %LIST            Request a list of areas available.
  711. %QUERY            Request a list of connected areas.
  712. <AREANAME> -R           Request a rescan for <AREANAME>
  713. %PACKER <TYPE>          Change the compression type
  714.             (ARJ/ZIP/ZOO/PAK/ARC/etc..)
  715. %NETPACKER <TYPE>       Change Netmail compression type.
  716. %PASSWORD <password>    Change AreaFix password to <password>
  717. %PASSIVE                Temporarily Disable all exports.
  718. %ACTIVE            ReEnable all exports.
  719. %+*** or %+ALL          Request all available areas
  720. %-*** or %-ALL          Disconnect all areas
  721.  
  722. Example:
  723.  
  724. By: Klaus Schaefer
  725. To: AREAFIX, MISTER MUSIKER (2:245/4)
  726. Re: password            <---- Areafix Password
  727. St: Pvt  Crash  Kill
  728. ------------------------------------------------------------
  729. IBM.GER            <----     Add area
  730. FLEA.GER
  731. -SYSOPS.024             <----   Remove area
  732. POINTS.MMM -R           <----   Rescan area
  733. %QUERY            <----     Ask for available areas
  734. %LIST            <----     List active areas
  735.  
  736.  
  737.  
  738. Areafix Uplink Requests
  739. -----------------------
  740.  
  741. If one of your downlinks orders an echo which is not available
  742. on your system xMail's built in Areafix is able to order this
  743. echo from one of your uplinks.
  744.  
  745. The downlink must have the 'Forward Area Requests' switch enabled,
  746. the uplinks have to be defined in XMAIL.CFG. More than one uplink
  747. can be defined.
  748.  
  749. UPLINK <adr> <arealist> <requestname> <password> <level>
  750.  
  751. adr:              Node address of the Uplink
  752.  
  753. arealist          Filename of an ASCII list with the names of the
  754.                 uplink's echos
  755.  
  756. requestname      The name of the uplink's Areafix (for example
  757.                 Areafix or Areamgr)
  758.  
  759. password          Your password for the uplink's Areafix
  760. level             Minimum level a downlink must have to forward
  761.                 his area request to this uplink
  762.  
  763. Example:
  764.  
  765. UPLINK 2:245/31 E:\XM\LISTS\22450031.LST Areafix GIBSON 100
  766.  
  767.  
  768. If a node request a new area and the request has to be forwarded
  769. to an uplink first xMail takes a look at the uplink's arealist
  770. to see if the echo is actually available. If yes the requesting
  771. node gets a short notify message and xMail creates a message
  772. to the uplink's areafix and requests  the desired areas.
  773.  
  774. If xMail cannot find the echo in one of the echolists the echo
  775. will be requested from the first uplink in your zone if the 
  776. requesting downlink has the ForceReq level defined in XMAIL.CFG.
  777.  
  778. When the requested areas are received from the uplink they will be
  779. created as passthru areas and attached to all nodes that have
  780. requested them and also to all nodes that have set 'Add new Echos'
  781. to YES and are in the zone of the uplink who sent the new echo to you.
  782.  
  783. Usually most other echomail processors are only able to forward
  784. an area request no matter if an echo really exists on one uplink
  785. system. This means request for echos which don't even exist might
  786. be routed throughout your network from system to system without
  787. ever getting the echo. What a mess.
  788.  
  789. That's the reason why xMail looks into the uplinks arealist
  790. first and checks if the echo exists.
  791.  
  792. The problem is that those lists are mostly not up to date. The
  793. solution: xMail creates the lists from the uplink's query
  794. message.
  795.  
  796. As it is impossible to recognise all different query formats of
  797. all echomail processors xMail will only create the area list
  798. file if the query message comes from xMail, Tosscan or the
  799. original Areafix. For all other Uplinks you can define a static
  800. list which for example could be the echolist of your network.
  801.  
  802. If you want xMail to create the echolist you must add a '+'
  803. before the filename of the list.
  804.  
  805. Examples:
  806.  
  807. UpLink  2:245/100 +C:\XM\LISTS\24500100.LST Areafix PASSWORD 100
  808. The list will be created.
  809.  
  810. UpLink  2:245/4    C:\XM\LISTS\24500004.LST Areafix PASSWORD 100
  811. The list will not be created.
  812.  
  813. The arealist will only be created if the query message is newer
  814. than the existing list. The old list will be renamed to *.OLD.
  815. With keyword QUERYSUBJECT you can define up to 10 subjects to
  816.  let xMail recognise a message as a query message from an uplink
  817. and the echo list for this uplink has to be created from this
  818. message. Default is 'Query'.
  819.  
  820. xMail also looks for parts of what you define here in the query
  821. message. Notice: The query mail MUST have one of the names you
  822. defined in the AREAFIXNAME statement as the name of the sender.
  823. Otherwise xMail will not recognise that the message comes from
  824. another Areafix.
  825.  
  826.  
  827.  
  828. Additional Areafix Features
  829. ---------------------------
  830.  
  831. Areafix can create unique notify and query messages using macros
  832. for nodename, nodenumber and several other system parameters.
  833. So you can make messages from your Areafix very personal and add
  834. statistical information for your downlinks (received mails, sent
  835. mails, password etc.).
  836.  
  837. One special Areafix function I want to mention is the
  838. 'holiday' switch. Normally if a node is not in town for
  839. a longer period he has to cancel all echos and order
  840. them again when he's back. Not with xMail's Areafix !
  841. Your downlink can simply write a message to Areafix
  842. with
  843.  
  844. %PASSIVE
  845.  
  846. in the message text. Areafix then will switch the
  847. complete node to passive, which means he will get no more
  848. echomail from you. When he is back and wants to continue
  849. receiving echomail he does not have to switch every
  850. single echo on but he may write to Areafix again:
  851.  
  852. %ACTIVE
  853.  
  854. and he will receive all echos again like he did before.
  855.  
  856. Please read sample XMAIL.CFG for more information about
  857. Areafix parameters.
  858.  
  859.  
  860. Areafix Messages
  861. ----------------
  862.  
  863. You can completely configure the text within the messages sent
  864. to nodes via QUERY, NOTIFY and AREAFIX. You do this
  865. by using special control characters, that will be replaced by
  866. actual data, in your textfiles. We have included some sample
  867. textfiles with this release of xMail, edit them as you feel
  868. needed.
  869.  
  870.  
  871.  
  872.                         MACROS available in all TEXTFILES
  873.                         =================================
  874.  
  875. &N         Full Name of node
  876. &F         First name of node
  877. &L         Last name of node
  878. &Y         Your global system address
  879.                 (NodeAdr = zone:net/node.point in XMAIL.CFG)
  880. &D         Date in your country style
  881. &T         Time in your country style
  882. &A         Address of receiving node
  883. &E         Number of messages the node has sent
  884. &I         Number of messages the node has received (you can 
  885.                 reset these two nodefile entries with XMSETUP from
  886.                 the fullscreen setup or from the command line.
  887. &J        Status: 'Pay User' or 'Normal User'
  888. &K              Actual Echomail Account (1/100)
  889. &M        Date of Last Notify
  890. &S         Sender address for the mail packets
  891. &P         Areafix password
  892. &B         Password for the mail packets
  893. &C         If node is active "Active" is shown, otherwise
  894.                 "Passive"
  895. &G         The name of the packer (ARJ,ZIP,etc)
  896. &Y              Limit the Pay-Users are checked for (only on
  897.                 CHECKCREDIT!)
  898. &Z              The echo that was disconnected with DELETEAREA
  899.  
  900.  
  901.  
  902.                         NETWORKS and MULTINODE ENVIRONMENT
  903.                         ==================================
  904.  
  905. Network Environment
  906. -------------------
  907.  
  908. xMail can run in multitasking environments such as DESQview
  909. and OS/2 or in Networks such as Novell.
  910.  
  911. xMail will detect DesqView and use DesqView's screen buffers.
  912. xMail also detects OS/2.
  913.  
  914. If you have SHARE loaded xMail will automatically switch to
  915. NETWORK mode and use special file and record locking schemes.
  916.  
  917. xMail will detect NOVELL and default to NETWORK Mode.
  918.  
  919. If you use any other network software or WINDOWS you have
  920. to use the /N+ switch to force xMail to network mode.
  921. Network mode of course is somewhat slower than  non-network
  922. (normal) mode, but xMail is really safe in a multiline
  923. environment. With xMail you can even define how many
  924. messages are being tossed before the base will be temporarily
  925. unlocked.
  926.  
  927. You can import or export mail while users are online in your
  928. BBS, and we have even tested simultaneous imports with xMail
  929. on more than one line. You don't even have to think about 
  930. complicated batchfiles, semaphores, or events, simply use
  931. xMail !
  932.  
  933. We have tested several other so called multiline echomail
  934. processors and came to a very surprising result: Some of them
  935. are absolutely unable to run safely in multiline or network
  936. environments. Some lock the messagebase on startup and unlock
  937. it when finished. That's funny... no user will be able to enter
  938.  a message while these tossers are running. But that's of course
  939. the reason why they call themselves FAST :-).
  940.  
  941. Locking and unlocking the base takes time, but xMail 1.00
  942. with it's new disk caching system is *STILL FASTER* than all
  943. other tossers we have tested!
  944.  
  945. Try and compare!
  946.  
  947.  
  948.  
  949.                         Multiline Tossing
  950.                         =================
  951.  
  952. xMail is introducing a new multiline concept!
  953.  
  954. xMail is now able to work in networks or multitasker environments
  955. with the same directories and data. This means you only need one
  956. inbound directory, one inpacket directory, one outpacket directory
  957. and one outbound directory for all lines!
  958.  
  959. Up to 16 lines (xMail/Pro) are supported which can import and export
  960. *simultaneously*! xMail will use different packet names for all
  961. lines so each line will never touch the packets created by other
  962. lines. This is the most secure and efficient system in multiline
  963. environment currently available.
  964.  
  965. The line number has to be given in the command line:
  966.  
  967. xMail IMPORT /Y<line_number>
  968.  
  969. Example:     xMail IMPORT /Y1
  970.                 Import on line 1.
  971.  
  972. If no line number is supplied xMail will automatically select
  973. the first free line number.
  974.  
  975. xMail uses a special file to keep track of used lines. On startup
  976.  xMail will login for the specified line and logoff after program
  977. execution. If the line is already in use xMail will abort execution.
  978.  
  979. This file (LINELOCK.XM) will automatically be created in the
  980. xMail directory.
  981.  
  982. xMail locks a line by writing a one byte code to the appropriate
  983. position in LINELOCK.XM. The unlock code is 00hex, xMail's
  984. lock code is 01hex. Other programs which support this locking scheme
  985. should use another code which can be given by the xMail team.
  986.  
  987. If a mail line remains locked because of a system crash or a program
  988. error the file LINELOCK.XM can simply be deleted. It will automatically
  989. be recreated on next xMail startup.
  990.  
  991. As all mailer lines on one system work with a shared netmail folder
  992. and file outbound directory xMail has to make sure that it only
  993. uses files under xMail's administration. This affects logfiles,
  994. mail packets and arcmail packets.
  995.  
  996. All these files are separated with the filename. On multiline systems
  997. unique filenames are used for all mail lines. The last character
  998. of the logfile's file extension contains the hexadecimal value of the
  999. line number (1hex..Fhex), and mail packets contain the line number
  1000. in the first character of the packet filename. This does not affect
  1001. Binkley and D'Bridge systems where the packet names are pre-defined.
  1002.  
  1003. Apart from lines 1..16 xMail supports special mail line 0 for
  1004. service and maintenance tasks. When you use line 0 all other
  1005. xMail lines have to be unlocked which will be checked on startup.
  1006. xMail then locks all 16 lines to execute service tasks like
  1007. CHECKCREDIT, CLEANUP, DELETEAREA etc. and unlocks all lines after
  1008. program execution.
  1009.  
  1010. Other utilities like XMPURGE may access LINELOCK.XM to prevent
  1011. parallel execution of xMail.
  1012.  
  1013.  
  1014.  
  1015.                         PAY ACCOUNTS
  1016.                         ============
  1017.  
  1018. xMail is the first echomail processor that offers you a
  1019. new echomail cost sharing and accounting system, great for
  1020. HUBs and other systems with many downlinks!
  1021.  
  1022. Maybe you have already thought about sharing the costs for
  1023. your echomail polls with your downlinks. xMail brings to
  1024. you an easy to use solution for this problem.
  1025.  
  1026. You can define the costs for each echo and give an account
  1027. to every downlink. The costs for every echomail message the
  1028. downlink received will be subtracted from his account.
  1029.  
  1030. There are two types of costs you can define for every echo.
  1031.  
  1032. 1. Absolute Costs: Every echomail 'costs' the downlink the
  1033. amount that you have defined for this echo (that could be
  1034. for example Cents), no matter how many downlinks receive
  1035. this echo. This amount is subtracted from his Echomail
  1036. Credit. If you have set Absolute Costs to zero no absolute
  1037. costs will be calculated for this echo.
  1038.  
  1039. 2. Relative Costs: The node only has to 'pay' the costs
  1040. per message devided through the number of downlinks. If
  1041. you have set Relative Costs in an echo to 20 and the echo
  1042. has 10 downlinks on your system, every receiver of this
  1043. echo has to pay 2 units per message. If you set Relative
  1044. Costs to zero no Relative Costs will be calculated for
  1045. this echo. Relative costs make echos cheaper that you poll
  1046. for many downlinks
  1047.  
  1048.   Both methods can be mixed. If you have set both fields to
  1049.  zero receiving this echo is free.
  1050.  
  1051.  
  1052.  
  1053.  
  1054.                         ERRORLEVELS
  1055.                         ===========
  1056.  
  1057. xMail will exit with the following errorlevels after execution.
  1058.  
  1059. 1               Echomail was imported
  1060. 2           Netmail was imported
  1061. 3           Both Echomail and Netmail were imported
  1062. 4           Echomail was exported
  1063. 8           Netmail was exported
  1064. 12          Both Echomail and Netmail were exported
  1065.  
  1066. All error codes above 90 show a program error:
  1067.  
  1068. 90          General program error
  1069. 91          Unable to open the messagebase
  1070. 92          Unable to create the messagebase
  1071. 93          The messagebase is corrupted
  1072. 94          Unable to close the messagebase
  1073. 97          Not enough memory
  1074. 98          Unable to flush files, don't use /S+ parameter!
  1075. 99          File locking error (network mode)
  1076. 240         Key not found
  1077. 241         Overlay Error
  1078. 250             Line locked
  1079. 254         Processor > 80286 required
  1080. 255         Runtime Error (program aborted with ^C)
  1081.  
  1082.  
  1083.     
  1084.                         CREDITS
  1085.                         =======
  1086.  
  1087. All brand and product names mentioned above are Copyrighted
  1088. Material, Trademarks or Registered Trademarks of their 
  1089. respective holders. JAM(mbp) is Copyright 1993 Joaquim
  1090. Homrighausen, Andrew Milner, Mats Birch, Mats Wallin.
  1091.  
  1092.  
  1093.  
  1094.                         SPECIAL THANKS
  1095.                         ==============
  1096.  
  1097. As you may have noticed it took quite a long time to bring out
  1098. this new version. Stefan was very busy building a house for his
  1099. family and I'm very much involved in my shop these days. We both
  1100. know that this slowed down xMail development a bit but I'm sure
  1101. you understand. We just want to say a BIG thank you for your great
  1102. support, your patience and your suggestions!
  1103.  
  1104.  
  1105.                       xMail Beta Team
  1106.                       ===============
  1107.  
  1108. This is in fact the best beta team a programmer can have.
  1109. Please keep up your good work! Thank you all, folks!!!
  1110.  
  1111.  
  1112. Mike Mast               Lancaster PA, USA               1:270/415
  1113. Rob Buckman             Ft. Walton Beach FL, USA        1:366/844
  1114. Mike Paschen            Hamburg, Germany                2:240/100
  1115. Wim Abels               Duesseldorf, Germany            2:242/20
  1116. Thorsten Seidel         Bad Lippspringe, Germany        2:242/55
  1117. Michael Hoess           Stuttgart, Germany              2:242/82
  1118. Mirko Mucko             Duesseldorf, Germany            2:242/94
  1119. Martin Brumm            Marburg, Germany                2:244/4343
  1120. Hans Koehncke        Wiesbaden, Germany        2:248/1
  1121. Marc de Bruin            Coevorden, Netherlands        2:282/209
  1122. Ad Damstra                Amsterdam, Netherlands        2:2801/1015
  1123. Tobias Gasser           Basel, CH                       2:301/234
  1124. Philippe Feuerstein     Saint-Clair, France             2:323/3
  1125. Michel Barthelemy       Saint-Firmin, France        2:323/10
  1126. Fil Grushevsky          Kiev, Ukraine                   2:463/34
  1127. Brian Jennings          Elizabeth West SA, Australia    3:800/839
  1128. Jim Melksham            Bellbird Park, Australia        3:640/190
  1129. Daryl Collins         Seaton SA, Australia        7:777/300       
  1130. Kelvin Goh              Singapore                       6:600/400
  1131. Mac Chou                Taipei, Taiwan, China           6:720/107
  1132. Shizuka J               Taipei, Taiwan, China           6:720/241
  1133.  
  1134.  
  1135. If *you* are interested in becoming an xMail Beta Team
  1136. member and think your system setup might be something special
  1137. and interesting for us please contact us!
  1138.  
  1139. We are also still looking for competent support sites in
  1140. some states.
  1141.  
  1142.  
  1143.  
  1144.                         DISCLAIMER
  1145.                         ==========
  1146.  
  1147. xMail is (c) Copyright 1991-1993 by Roger Kirchhoff
  1148. and Stefan Graf. You can reach us at 2:243/4510@fidonet.org
  1149. and 2:245/4@fido.classic (xMail H.Q.) +49-2351-786580.
  1150.  
  1151. We only guarantee that xMail will occupy disk space.
  1152. In no event shall we be liable to you or anyone else
  1153. for any damages or costs, including, but not limited
  1154. to, any lost profits, lost savings, lost income, lost
  1155. information or other incidental or consequential
  1156. damages arising out of the use or inability to use
  1157. xMail.
  1158.  
  1159. If you have any suggestion or bug reports please let us
  1160. know.
  1161.  
  1162.