home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 2 BBS / 02-BBS.zip / mmov1b25.zip / mmover.doc < prev    next >
Text File  |  1995-05-11  |  15KB  |  372 lines
  1.                  ╔══════════════════════════════════════╗
  2.                  ║                                      ║
  3.                  ║  MMover Version 1.0 BETA2            ║
  4.                  ║  Squish mail filter for OS/2         ║                 
  5.                  ║  EC-Software development             ║
  6.                  ║                                      ║
  7.                  ║  Copyright (c) 1995 René Ledosquet   ║
  8.                  ║  Squish API (c) 1991 Scott J. Dudley ║
  9.                  ║                                      ║
  10.                  ╚══════════════════════════════════════╝
  11.  
  12.  
  13. License
  14. ═══════
  15.                                  
  16. MMover is shareware. You are allowed to test and use this program for
  17. 30 days. After this period you must register your copy with the author, if
  18. you want to continue to use it. See "Registration" in this manual.
  19.                                  
  20. You may distribute the shareware version of MMover, either through
  21. electronic media e.g. BBS'es or on diskettes. You may charge for the
  22. distribution, but not more than $5. You may distribute only the complete
  23. and unaltered archive.
  24.                                  
  25. You may install the registered version on more than one machine. However, you
  26. must make sure that it is only used on one machine at a time. As soon as
  27. it is used on more than one machine at a time, you need additional
  28. licenses.
  29.                                
  30. The author do not guarantee for the correctness of the program. I also may not
  31. be held responsible for any loss of data or other damages caused by the use of
  32. MMover. I don't guarantee that the program can be used for a specific purpose.
  33.                                  
  34. If you like to distribute the program in conjunction with commercial software
  35. or hardware ("bundling"), you must have a written permission of the author
  36. to do so.
  37.  
  38. If MMover is to be included in a collection of other freeware or shareware
  39. shareware programs on CD-ROM or diskette, i'd like to get a free copy. ;-)
  40.  
  41. Registering MMover does _not_ include a license for Squish (TM), which may
  42. be necessary for commercial users.
  43.  
  44. A licence always is a version licence, i.e. it is valid for all versions
  45. of the program that have the same major version number. You need to
  46. aquire a new licence when the new version has a major version number that
  47. is different from that of the older version.
  48.  
  49.  
  50. What is MMover?
  51. ═══════════════
  52.  
  53. MMover is a 32-bit OS/2 feature DLL for the SquishMail Processor. It filters 
  54. incoming mail due to certain criteria. 
  55.  
  56. Why MMover ?
  57. ════════════
  58.  
  59. Because of the fact that MMover is a feature-DLL, it prcesses mail during
  60. tossing and not afterwards like other filter utilities. This fact has a 
  61. simple but major advantage. MMover don't miss any mails when an area is
  62. overflowing. For example: you have restricted all areas to 400 mails.
  63. Now 500 new mails are coming for an area. You will loose 100 new mails, 
  64. because the area will overflow. That's a pidy. But even worse, a normal 
  65. mail filter programm, which runs after tossing, would miss 100 mails.
  66. Not with MMover !!! MMover gives you the chance to get the mails of your 
  67. interest, although the area overflows.
  68.  
  69. Installation
  70. ════════════
  71.  
  72. Unpack the archive in the same directory like Squish. 
  73.  
  74.  
  75. Configuration
  76. ═════════════
  77. First you have to add 2 lines in your SQUISH.CFG to activate MMover.
  78.  
  79. Add the following two lines: 
  80.  
  81. FEATURE32 MMOVER32
  82. MMOVER
  83.  
  84. Then you have to add a special MMover echoarea. This area is needed to avoid
  85. problems which appear, because of the Squish tossing technique. It is only
  86. used during run-time and will be set to 0 msg afterwards.
  87.  
  88. To add this area enter to following line in SQUISH.CFG (area part):
  89.  
  90. LOCALAREA MMOVER [path+rootname] -$
  91.  
  92. for example: LOCALAREA MMOVER D:\MSG\MMOVER -$
  93.  
  94. This is all you have to do in SQUISH.CFG !
  95. Now configurate your personal settings in MMOVER.CFG. Put your MMOVER.CFG in
  96. the same directory like your squish configuration file.
  97.  
  98. The commands in the MMOVER.CFG file have the following form:
  99.  
  100. <Function> {
  101.  <statement>
  102.  [...]
  103. }
  104.  
  105. <Function> {
  106.  <statement>
  107.  [...]
  108. }
  109.  
  110. [...] 
  111.  
  112.  
  113. MMover supports four functions (at the current state).
  114.  
  115.   - COPY
  116.   - MOVE 
  117.   - KILL
  118.   - READDRESS
  119.  
  120. The COPY function:
  121. This function copies the specific mail to the orginal area and to a user
  122. specific area. 
  123.  
  124. Statements for COPY:
  125.  
  126. STATEMENT│  COUNT │SYNTAX               │ MEANING
  127. ─────────┴────┬──┬┴─────────────────────┼──────────────────────────────────
  128.  ORGAREA:     │ !│ areaname [areaname..]│ Mail have to go to one of the
  129.               │  │                      │ specified areas.
  130.               │  │                      │ 
  131.               │  │ ALLECHO              │ ALLECHO keyword represends all
  132.               │  │                      │ Echoareas defined in SQUISH.CFG
  133.               │  │ ALLNET               │ ALLNET keyword represends all
  134.               │  │                      │ Netareas defined in SQUISH.CFG
  135.               │  │ !areaname [!areaname]│ excludes the specified area(s)                                    
  136.  NEWAREA:     │ !│ areaname             │ Area where the copy will be placed                                                                                                         
  137.  TO:          │ +│ Pattern[@address]    │ searchpattern that have to be in
  138.           │  │                      │ the TO field of the mail
  139.  FROM:        │ +│ Pattern[@address]    │ seach in the FROM field for pattern
  140.  SUBJ:        │ +│ Pattern              │ seach in the SUBJECT field
  141.  BODY:        │ +│ Pattern              │ seach in the messagetext for pattern
  142.  ATTRIB:      │[]│ attribut flag(s)     │ mail must have the attributes
  143.  NEWATTRIB:   │[]│ attribute flag(s)    │ new msg will get this new attributes
  144.           │  │                      │ and the org. attributes
  145.  OPTION:      │[]│ option flag(s)       │ Flags are processed
  146.            
  147.  
  148. If you use the ALLECHO or/and ALLNET keywords, it is recommend that these 
  149. are the first entries in the ORGAREA line.
  150. In Echomail the address entries are only recognized for the FROM: field.
  151.  
  152. Signes in COUNT:
  153.                 ! = statement has to be defined
  154.                 []= statement is optional
  155.                 * = it is allowed to enter multipel entries of this statement
  156.                 + = one or more out of the statements with the + sign have to
  157.                     be defined (connected via logical AND)
  158.  
  159. All seachpattern are case insensitive. The following jokers are allowed.
  160.  
  161.   JOKER│ Bedeutung
  162.   ─────┼──────────────────────────────────────────────────────────────────
  163.     ?  │ A ? stands for any character.
  164.        │ Example: J?ker = Joker, Jaker, Jlker...
  165.     *  │ A * represends a string of any character (including space) 
  166.        │ Example: b*t = bot, bt, beat, bett, sub yellow teacher...
  167.          !!! Use this joker with extreme care !!!
  168.          You don't have to put normal searchpattern like "harddisk" in
  169.          *'s (*harddisk*). Don't do it. 
  170.                           
  171.  
  172. The OPTION: statement is optional.
  173. Valid entries for the OPTION: statement are:
  174.   
  175.   c = don't generate comment on mail. (This mail was moved by ...)
  176.   k = insert an areakludge of the original destination area in the mail.
  177.       This is nice when you reply to a mail and you want to put the reply in
  178.       a different area. Some editors which support this function need this
  179.       area kludge to find the reply's destination area automatical.
  180.  
  181. Valid ATTRIB: and NEWATTRIB: flag are:
  182. p = MSGPRIVATE
  183. c = MSGCRASH
  184. r = MSGREAD
  185. s = MSGSENT
  186. f = MSGFILE
  187. w = MSGFWD
  188. o = MSGORPHAN
  189. k = MSGKILL
  190. l = MSGLOCAL
  191. h = MSGHOLD
  192. q = MSGFRQ
  193. b = MSGRRQ
  194. t = MSGCPT
  195. a = MSGARQ
  196. u = MSGURQ
  197.  
  198. EXAMPLE:
  199.  
  200. ; This would instuct MMover to copy every echomail addressed to me at
  201. ; 2:2435/612 in my special backup area and to set the
  202. ; areakludge of the original area for easy-replies
  203.  
  204. COPY {
  205. ORGAREA: ALLECHO !MYONE
  206. NEWAREA: MYONE
  207. TO: rene ledosquet@2:2435/612
  208. OPTION: k
  209. }
  210.  
  211.  
  212.  
  213. The MOVE function:
  214. This function is quite the same as the COPY function except that it kills the
  215. original mail. The mail ONLY goes to the new area.
  216.  
  217. Statements for MOVE:
  218.  
  219. STATEMENT│  COUNT │SYNTAX               │ MEANING
  220. ─────────┴────┬──┬┴─────────────────────┼──────────────────────────────────
  221.  ORGAREA:     │ !│ areaname [areaname..]│ Mail have to go to one of the
  222.               │  │                      │ specified areas.
  223.               │  │                      │
  224.               │  │ ALLECHO              │ ALLECHO keyword represends all
  225.               │  │                      │ Echoareas defined in SQUISH.CFG
  226.               │  │ ALLNET               │ ALLNET keyword represends all
  227.               │  │                      │ Netareas defined in SQUISH.CFG
  228.               │  │ !areaname [!areaname]│ excludes the specified area(s)
  229.  NEWAREA:     │ !│ areaname             │ Area where the mail will be placed
  230.  TO:          │ +│ Pattern[@address]    │ searchpattern that have to be in
  231.           │  │                      │ the TO field of the mail
  232.  FROM:        │ +│ Pattern[@address]    │ seach in the FROM field for pattern
  233.  SUBJ:        │ +│ Pattern              │ seach in the SUBJECT field
  234.  BODY:        │ +│ Pattern              │ seach in the messagetext for pattern
  235.  ATTRIB:      │[]│ attribut flag(s)     │ mail must have the attributes
  236.  NEWATTRIB:   │[]│ attribute flag(s)    │ new msg will get this new attributes
  237.           │  │                      │ and the org. attributes
  238.  OPTION:      │[]│ option flag(s)       │ Flags are processed
  239.  
  240.                                                                                                                      
  241. The KILL function:
  242. This function is quite simple. It kills the mail which matches the specified
  243. criteria. Use this function with extreme care, especialy when you have 
  244. downlinks.
  245.  
  246. Statements for KILL:
  247.  
  248. STATEMENT│  COUNT │SYNTAX               │ MEANING
  249. ─────────┴────┬──┬┴─────────────────────┼──────────────────────────────────
  250.  ORGAREA:     │ !│ areaname [areaname..]│ Mail have to go to one of the
  251.               │  │                      │ specified areas.
  252.               │  │                      │
  253.               │  │ ALLECHO              │ ALLECHO keyword represends all
  254.               │  │                      │ Echoareas defined in SQUISH.CFG
  255.               │  │ ALLNET               │ ALLNET keyword represends all
  256.               │  │                      │ Netareas defined in SQUISH.CFG
  257.               │  │ !areaname [!areaname]│ excludes the specified area(s)
  258.  TO:          │ +│ Pattern[@address]    │ searchpattern that have to be in
  259.           │  │                      │ the TO field of the mail
  260.  FROM:        │ +│ Pattern[@address]    │ seach in the FROM field for pattern
  261.  SUBJ:        │ +│ Pattern              │ seach in the SUBJECT field
  262.  BODY:        │ +│ Pattern              │ seach in the messagetext for pattern
  263.  ATTRIB:      │[]│ attribut flag(s)     │ mail must have the attributes
  264.  
  265.  
  266.  
  267. The READDRESS function:
  268. This function changes the dest. address of a NETMAIL to a different address.
  269.  
  270. Statements for READDRESS:
  271.  
  272. STATEMENT│  COUNT │SYNTAX               │ MEANING
  273. ─────────┴────┬──┬┴─────────────────────┼──────────────────────────────────
  274.  ORGAREA:     │ !│ areaname [areaname..]│ Mail have to go to one of the
  275.           │  │                      │ specified areas. ONLY NETAREAS
  276.           │  │                      │ are allowed !
  277.           │  │ ALLNET               │ ALLNET keyword represends all
  278.           │  │                      │ Netareas defined in SQUISH.CFG
  279.           │  │ !areaname [!areaname]│ excludes the specified area(s)
  280.  NEWAREA:     │[]│ areaname             │ Area where the copy will be placed
  281.           │  │                      │ ONLY one NETAREA is allowed !
  282.  NEWTOADDR:   │ !│                      │ The dest. address will be changed
  283.           │  │                      │ to this address
  284.  TO:          │ !│ Pattern[@address]    │ searchpattern that have to be in
  285.           │  │                      │ the TO field of the mail
  286.  FROM:        │[]│ Pattern[@address]    │ seach in the FROM field for pattern
  287.  SUBJ:        │[]│ Pattern              │ seach in the SUBJECT field
  288.  BODY:        │[]│ Pattern              │ seach in the messagetext for pattern
  289.  ATTRIB:      │[]│ attribut flag(s)     │ mail must have the attributes
  290.  NEWATTRIB:   │[]│ attribute flag(s)    │ new msg will get this new attributes
  291.           │  │                      │ and the org. attributes
  292.  OPTION:      │[]│ option flag(s)       │ Flags are processed
  293.            
  294.  
  295. If you use the ALLNET keyword, it is recommend that this is the first
  296. entry in the ORGAREA line. If you do not define NEWAREA, the readdress msg 
  297. will be placed in the orig. netarea.
  298.  
  299.  
  300.  
  301. Registration
  302. ════════════
  303.  
  304. If you decide to register this programm, you will have to pay the registration
  305. fee. Then you will recieve a personal registration key, and instructions how
  306. to register your shareware copy of MMOVER. This process will disable the beep
  307. and the short delay. The registered version will show your name after the 
  308. "registered to:" field. This is it. There are no disabled features in the
  309. shareware version! You can test this programm completely before registration.
  310. If you register, you support the shareware concept and further development of
  311. this software !!! 
  312.  
  313. The registration fee is 20.- DM. (any greater amount is welcome ;-) )
  314.  
  315. To pay use:
  316.  
  317. - money transfer order to
  318.  
  319.      René Ledosquet
  320.      account number 493929
  321.      at Volksbank Marburg, Germany
  322.      bank code 533 90 000
  323.      
  324.   Please specify 
  325.     "Reg. MMover 1", your full name, address to reach you.
  326.     
  327.   Always use a method where you pay the bank fee!
  328.   
  329. - Cash by postal mail (risky)
  330.  
  331. - Collection-only check to
  332.  
  333.     René Ledosquet
  334.     Biegenstr. 45
  335.     35037 Marburg
  336.     
  337.   payable in German Marks
  338.      
  339.  
  340. If you pay via postal mail (cash or collection-only check) add your address
  341. (normal and  FIDO, E-Mail ...) and your full name. You can then recieve your
  342. key on two ways, via postal mail or i put it on HOLD (2:2435/612) for you.
  343. If you like me to send you your key via postal mail, put enough free stamps
  344. in your envelope.
  345.  
  346. If you pay via money transfer order don't forget to add:
  347.  
  348.   "Reg. MMover 1", your full name, addresses (normal, FIDO, E-Mail)
  349.   
  350. and - if possible - send me a netmail or e-mail that you would like to
  351. register and that the money is on its way. Add also on which way (E-mail or 
  352. FIDO HOLD) you would like to recieve the registration key from me. As soon as
  353. i checked back with the bank, i will send you your registration key. 
  354.  
  355.  
  356.  
  357. To reach the author:
  358. ═══════════════════
  359.  
  360. FIDO:  2:2435/612 (The Electic Chair Node#3)
  361. E-MAIL: rl@sg1601.pharmazie.uni-marburg.de
  362. POSTAL MAIL:
  363.              René Ledosquet
  364.              Biegenstr. 45
  365.              35037 Marburg
  366.              
  367.  
  368.  
  369. MMover 1.0 beta #2
  370. (c) by René Ledosquet
  371. 11.05.95
  372.