home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 35 Internet / 35-Internet.zip / archiver.zip / MANUAL < prev    next >
Text File  |  1998-07-14  |  34KB  |  851 lines
  1. PMMail Archiver, Copyright (c) 1998, Jonathan B. Bayer
  2.  
  3.  
  4. Table of Contents
  5. -----------------
  6.  
  7. Overview
  8. Installation
  9. Performance
  10. Usage
  11. Calling as an external Hook from within PMMail
  12. Command Line Syntax
  13. Configuration File Options and Syntax
  14. Creating a test directory
  15. So You Need To Restore A File
  16. Command Line Examples
  17. Configuration File Examples
  18. Multiple folder filters
  19. External Exit/Hook Examples
  20. InfoZip and InfoUnzip
  21. Program overview
  22. Registration Information
  23. Support
  24. __________________________________________________________________________
  25.  
  26. Overview
  27. --------
  28.  
  29. PMMail is a great e-mail program.  One of the shortcomings it has
  30. (along with most other e-mail programs) is the inability to archive
  31. messages.
  32.  
  33. PMMail Archiver is designed to fill this void.  It can archive messages,
  34. reindex the message folders, and sort the address book.  As a bonus an
  35. additional program has been included called Attach.  This program is
  36. designed to remove the complete path from e-mail attachments, leaving
  37. just the file name.  See the file ATTACH.TXT for instructions on using
  38. the Attach program.
  39.  
  40. Upon registration you will receive the latest copy of PMMail Archiver,
  41. along with an additional program called Detach, which can automatically
  42. detach attached files from e-mail messages and place them in specified
  43. directories.
  44.  
  45. This program was written as a command-line driven program so that
  46. it could be called from within PMMail as an external hook, usually upon
  47. exiting the program.
  48.  
  49. PMMail Archiver can be driven entirely from the command line, or a
  50. configuration file may be set up for most common parameters.
  51.  
  52. The program is available in Windows and OS/2 versions.  The Windows
  53. version of the program is called "warchive.exe", and the OS/2 version
  54. is called "oarchive.exe".  Throughout this manual the program is
  55. referred to as "archiver" or "archiver.exe".  Simply replace the
  56. "archiver" with the appropriate name for the operating system you are
  57. using.
  58.  
  59. Folders are "filtered" according to the criteria specified on the
  60. command line and in the (optional) configuration file.  Nested folders
  61. will be of a folder that does not match the criteria will still have
  62. the filters applied to them.  Also, you can specify a path of folder
  63. directory names to archive a specific folder.  See the examples for
  64. more specific information on this feature.
  65.  
  66. Files are "filtered" according to the criteria specified on the
  67. command line and in the (optional) configuration file.  Filter options
  68. can be either all required, or any required.  If all required is
  69. specified then a message will need to match all filter options before
  70. it is archived/restored.  If any required is specified then a message
  71. will need to match only one filter option for it to be archived/restored.
  72.  
  73. Files are archived into a standard zip file.  There is an additional
  74. file created called "backup.bag" which contains the PMMail information for
  75. each file archived.
  76.  
  77. Restored files are put into a special folder created by the program,
  78. called "Restored Files".  This folder is created in each account that
  79. has files restored.  Inside this folder the program will recreate the
  80. same folder hierarchy as existed when the file(s) were archived.  It will
  81. not create empty folders.
  82. __________________________________________________________________________
  83.  
  84. Installation
  85. ------------
  86.  
  87. There is no installation script.  Copy the executable to either the
  88. PMMail Tools directory, or the PMMail executable directory.  Either
  89. make sure that it is in your path, or call it directly.
  90.  
  91. __________________________________________________________________________
  92.  
  93. Performance
  94. -----------
  95.  
  96. The performance of PMMail Archiver will depend upon several factors.  Some
  97. of them are:  Speed of your computer, memory available, number of files
  98. to archive.
  99.  
  100. An exact number cannot be specified, however I am listing some performance
  101. statistics below which will give you an idea of the time it will take to
  102. archive your files:
  103.  
  104. ==========================================================================
  105. Computer:   P-133, 80 meg. memory
  106. OS:         OS/2 Warp 3
  107.  
  108. Files to be archived:  Multiple accounts, total of 5114 messages.
  109.  
  110. Action                                                      Time used
  111. --------------------------------------------------          ---------
  112. Reading the directories.  Lots of disk activity.              1:40
  113. Zip processing file list,  Very little disk activity         13:00
  114. Zip creating zip file, high disk activity                     4:30
  115. Rewriting bag files                                           0:25
  116. Deleting archived files                                       4:00
  117.  
  118.  
  119. ==========================================================================
  120. Computer    P-200 MMX, 32 meg. memory.
  121. OS:         OS/2 Warp 4 with FixPak 5 applied.
  122.  
  123. Files to be archived:  One account, total of 7946 files..
  124. Action                                                      Time used
  125. --------------------------------------------------          ---------
  126. Reading the directories.  Lots of disk activity.              2:58
  127. Zip processing file list,  Very little disk activity         36:12
  128. Zip creating zip file, high disk activity                     2:28
  129.  
  130. __________________________________________________________________________
  131.  
  132. Usage
  133. -----
  134.  
  135. The program has the following functions:
  136.  
  137. Archiving of message files
  138. Restoration of message files
  139. Reindexing of message folders
  140. Sorting address book
  141.  
  142.  
  143.         Archiving
  144.         ---------
  145.         The program takes the filter parameters the user specifies on
  146.         either the command line or in the configuration file (or both).
  147.         It creates a file called "backup.bag" which contains all the
  148.         "folder.bag" entries for the files which are being archived.  The
  149.         archive process will archive this file along with all the message
  150.         files (and INI files for the folders).  If requested the program
  151.         will delete the archived files and update the "folder.bag" files
  152.         for each folder.
  153.  
  154.         Restoration
  155.         -----------
  156.         The program takes the filter parameters specified and the archive
  157.         file specified on the command line.  It unzips the "backup.bag"
  158.         file and examines it applying the filters to each entry.  After
  159.         this it will, if necessary, create a folder in each account called
  160.         "Restored Files" which will contain all files restored for that
  161.         account.  Inside this folder it will recreate the folder structure
  162.         which existed at the time the archive was created and restore the
  163.         files to the same folder (inside the "Restored Files") where they
  164.         were before.
  165.         If query mode is on the user will be asked about each file before
  166.         it is restored.
  167.  
  168.         If the account being restored does not exist then the account
  169.         directory and the "acct.ini" file will be restored.
  170.  
  171.         If you perform an archive after restoring files, all the files in
  172.         "Restored Files" folder will be eligible for archiving again.
  173.  
  174.         Reindexing
  175.         ----------
  176.         The program takes the specified accounts and ignores all other
  177.         parameters.  It will then re-index all folders in the specified
  178.         accounts.  It reads each file, and if a "folder.bag" entry exists
  179.         for that file it will preserve the file priority and status.  It
  180.         will rewrite each "folder.bag" file in each directory with updated
  181.         information.
  182.  
  183.  
  184.         Sorting
  185.         -------
  186.         The program will sort the address book using the specified field.
  187.         It currently does an ascending sort only.
  188.  
  189. __________________________________________________________________________
  190.  
  191. Calling as an external Hook from within PMMail
  192. ----------------------------------------------
  193.  
  194. PMMail can call an external program at several points.  If you wish
  195. to call this from within PMMail it is safest to call it when exiting the
  196. program.  If you have one set of parameters then you can call the program
  197. directly from within PMMail, otherwise you will need to create a batch/
  198. command file and call the archiver several times with the different
  199. parameters.
  200.  
  201. OS/2
  202. ----
  203. At the main screen select the PMMail menu, go into Settings, and go to the
  204. Rexx page.
  205.  
  206. Enable the Program Close Exit, and put either the program name & options
  207. or the Rexx command file in the entry field.
  208.  
  209. Windows
  210. -------
  211. At the main screen select the PMMail menu, go into Properties, and go to
  212. the User Hooks page.
  213.  
  214. Enable the Program close hook, and put either the program name & options
  215. or the batch file in the entry field.
  216.  
  217. __________________________________________________________________________
  218.  
  219. Command Line Syntax
  220. -------------------
  221.  
  222. Usage:   archiver  [parameters] [archive file name]
  223.  
  224. The program must either be run from the main PMMail directory, or
  225. the main directory must be specified using the /p parameter.
  226.  
  227. ***** IMPORTANT *****
  228.  
  229. This program REQUIRES the latest versions of InfoZip and InfoUnzip.
  230. Currently the latest version of InfoZip is 2.2, and the latest version
  231. of InfoUnzip is 5.32.
  232.  
  233. If no archive file is specified then the program will create a file in
  234. the current directory called ARCHIV??.ZIP, where the question marks will
  235. be replaced by a sequential series of numbers.
  236. A specified archive file name can have question marks embedded, and the
  237. question marks will be replaced as above.
  238.  
  239. The archive file is NOT optional when doing a restore.
  240.  
  241. ANY parameter on the command line will totally override the corresponding
  242. parameter in the configuration file.  You can have multiple entries for
  243. some of the command line parameters, but if you even specify one of them
  244. on the command line the program will totally ignore any of the same
  245. parameters in the configuration file.
  246.  
  247. Command Line Parameters -  either a dash, plus, or forward slash are
  248.                            acceptable.  The parameters ARE case sensitive.
  249.  
  250. Location parameters     Multiple Description
  251.                         Allowed
  252. -------------------     -------- -----------
  253. /c configFileDirectory           Specify the location of the
  254.                                  configuration file (archive.cfg).
  255. /c configFile                    Specify the complete path of
  256.                                  the configuration file.
  257. /c NONE                          Do not use a configuration file.
  258. /p pmmaildirname                 If no accounts specified then will
  259.                                  perform work on all accounts.
  260. /a accountdirname        Yes     If /p not specified then either the
  261.                                  complete path is required, or the program
  262.                                  must be run from the PMMail directory
  263.                                  (where the accounts are).
  264. /b accountName           Yes     Full or partial name of account.
  265.  
  266. These parameters are currently inclusive or'd together.  In other words,
  267. if ANY parameter is met then the file will be archived/unarchived.  This
  268. can be changed by specifying the /R option on the command line, or the
  269. AllRequired parameter in the configuration file.
  270.  
  271.  
  272. Archive parameters      Multiple Description
  273. Unarchiving parameters  Allowed
  274. ----------------------  -------- -----------
  275.  
  276. Filter Options
  277. --------------
  278.  
  279. /f folderdirname         Yes     Directory name of the folder directory
  280.                                  containing messages to be archived or
  281.                                  restored.
  282. /G foldername            Yes     PMMail text name of folder containing
  283.                                  messages to be archived or restored.
  284. /A age in days                   Anything older than this gets archived.
  285. /d datecutoff                    Specifies the message date at which to
  286.                                  start archiving message.  Format must be
  287.                                  [yy]yy/mm/dd.  This uses the date the
  288.                                  message was saved on the system.
  289. /D messageDateCutoff             Same as /d except uses the date in the
  290.                                  message instead of the date the message
  291.                                  was saved.
  292. /t timecutoff                    Specifies the message at which to start
  293.                                  archiving.  This must be used with
  294.                                  either the /d (dateCutOff) or /D
  295.                                  (messageDateCutoff) options.
  296.                                  The format must be hh:mm, although the
  297.                                  colon is optional.
  298. /s subject               Yes     Subject match.  This will match the
  299.                                  beginning of the subject.  The match
  300.                                  will not be case sensitive.
  301. /S subject               Yes     Partial subject match.  This will match
  302.                                  anywhere in the subject. The match will
  303.                                  not be case sensitive.
  304. /F address               Yes     From address.
  305. /T address               Yes     To address.
  306.  
  307.  
  308. Other options
  309. -------------
  310. /N                               Delete files after archive process is
  311.                                  complete.
  312. /V 1                             Verbose mode.  Tell me what you are doing
  313. /V 2                             Verbose mode, but do not delete.  This
  314.                                  overrides the /N option.
  315. /V 3                             Verbose mode, but do not archive or
  316.                                  delete.
  317. /V 4                             Show all specified options and exit
  318. /O [filename]                    Send a copy of all output to the
  319.                                  specified file.  If no file specified
  320.                                  then send output to file "archiv??.rpt".
  321. /q                               If verbose mode is specified then make
  322.                                  the zip/unzip operations quiet.  If no
  323.                                  verbose mode is specified then make the
  324.                                  zip/unzip operations noisy.
  325. /Q                               Query mode for restore only.
  326. /n                               Toggle the nestedFolder option.  NestedFolders
  327.                                  are initially off.  This is a position dependent
  328.                                  option.  It only affects folders specified AFTER
  329.                                  it occurs.  It can occur multiple times on the
  330.                                  command line.
  331.  
  332. /r                               Restore files.
  333. /R                               Required.  Make all filters required.
  334. /o                               Restore files to original location.
  335.  
  336.  
  337. Folder and Sort Parameters
  338. --------------------------
  339.  
  340. /i  [option]                     Option to specify sorting of address book.
  341.                                  Option can be one of:
  342.                                              name
  343.                                              alias
  344.                                              email
  345.                                              company
  346.                                  If no option is specified then
  347.                                  the default sort is by alias.
  348. /I                               Option to specify reindexing.
  349.  
  350. __________________________________________________________________________
  351.  
  352. Configuration File Options and Syntax
  353. -------------------------------------
  354.  
  355. The configuration file is a text file, with one statement per line.  The
  356. following rules apply to the file:
  357.  
  358.    a. Comments begin with a pound sign or number sign.
  359.    b. Statements are not case sensitive.
  360.    c. Spaces at the beginning and end of the line are ignored.
  361.    d. Line beginning with a slash is interpreted just like a command line.
  362.    e. Statement begins line, followed by white space (either tabs or
  363.       spaces), followed by data.  If data has spaces then it needs to begin
  364.       with a single or double quote.  Quotes can be embedded by escaping
  365.       them with a backslash.  Data ends at either the end of the line or a
  366.       closing quote.
  367.    f. Only one of each statement is allowed in the configuration file,
  368.       unless specifically noted as allowing multiple entries.
  369.    g. All configuration options will be overridden by options specified
  370.       on the command line.
  371.  
  372.  
  373. The default name of the file is "archive.cfg".  The location of the
  374. configuration file can be specified on the command line using the /c
  375. option (see above).  Also, the /c option can specify the full path name
  376. of a configuration file.  This gives you the ability to have multiple
  377. configurations.
  378.  
  379. The statements are not case sensitive.
  380.  
  381. Allowable statements for the configuration file are:
  382.  
  383.    Statement        Multiple  Description
  384.                     Allowed
  385.    ---------        --------  -----------
  386.    pmmailDirName              Specify the location of the PMMail
  387.                               directory.
  388.    accountDir         Yes     Specify the account directory(ies) to
  389.                               archive.
  390.    accountName        Yes     Specify the full or partial account name(s).
  391.  
  392.  
  393.    Filter Statements
  394.    -----------------
  395.    folderDir          Yes     Specify the folder directory(ies).
  396.    folderName         Yes     Specify the full or partial folder name(s).
  397.    NestedFolders [yes|no]     A position dependent option.  If "yes" then
  398.                               all folder filters following this will
  399.                               match both the folder and all folders
  400.                               nested within it.  If "no" then the folder
  401.                               filters will have to match exactly.  This
  402.                               statement can appear multiple times in the
  403.                               configuration file.
  404.    fileAge                    Specify the minimum age before a file will
  405.                               be archived.
  406.    dateCutOff                 Specify the latest date (in YYYY/MM/DD) for
  407.                               a file to be archived.
  408.    messageDateCutoff          Specify the latest date (in YYYY/MM/DD) for
  409.                               a file to be archived.  Use the message date
  410.                               instead of the saved date.
  411.    TimeCutOff                 Specify the time together with the either the
  412.                               dateCutOff or messageDateCutoff for a file to
  413.                               be archived.  This option cannot be used by
  414.                               itself.  The time format must be hh:mm,
  415.                               although the colon is optional.
  416.    beginSubject       Yes     Specify the full or partial subject.  If
  417.                               the subject has spaces then surround it with
  418.                               quotes.  The subject must begin with this
  419.                               text.
  420.    PartialSubject     Yes     Specify a partial subject.  This text can
  421.                               appear anywhere within the subject.  Again,
  422.                               if spaces are included surround the text
  423.                               with quotes.
  424.    fromAddress        Yes     Specify the address from which the mail came.
  425.    toAddress          Yes     Specify the address to which the mail was
  426.                               sent.
  427.    fileSize                   In K, any file as big or bigger than the
  428.                               specified size will be archived.
  429.  
  430.  
  431.    Miscellaneous Statements
  432.    ------------------------
  433.    archiveFile                Specify the name of the archive file.
  434.                               Putting question marks in will let the
  435.                               program create a sequential series of
  436.                               archives.  See the description of the
  437.                               archive file name earlier.
  438.    Delete                     Flag to indicate that the files are to be
  439.                               removed after the archiving is completed.
  440.    verbose                    Be noisy.  See the options earlier.
  441.    OuputFileName [filename]   Send a copy of all output to the
  442.                               specified file.  If no file specified
  443.                               then send output to file "archiv??.rpt".
  444.    Sort [option]              Specify Address book sort option.  If this
  445.                               option is specified then the address book
  446.                               will be sorted after all other operations
  447.                               (if any) are completed.
  448.                               The option can be one of:
  449.                                              name
  450.                                              alias
  451.                                              email
  452.                                              company
  453.                               If no option is specified then the default
  454.                               sort is by alias.
  455.  
  456.    archiveDay                 Day of week to archive the files.  The day
  457.                               must be at least two (2) characters long for
  458.                               uniqueness.
  459.    allRequired                If present then all options need to be met
  460.                               before a file will be archived.  If not
  461.                               present then any matching option will cause
  462.                               a file to be archived.
  463.    OriginalLocation           For restore operation only, restore files
  464.                               to their original locations instead of
  465.                               into the restore folder.
  466. __________________________________________________________________________
  467.  
  468. Creating a test directory
  469. -------------------------
  470.  
  471. It is recommended that you create a test directory where you can try out
  472. this program without any chance of deleting messages from PMMail.  The
  473. easiest way would be to simply copy the entire directory structure to
  474. another area on your disk:
  475.  
  476. ---------------------------------------------------------------------
  477.  
  478. For example, assume that PMMail is located in c:\southsde\PMMail, and you
  479. want to copy it on the same disk.
  480.  
  481. Create a subdirectory called Test (or anything else you want to), and
  482. simply xcopy PMMail into it:
  483.  
  484.    xcopy c:\southsde  test\southsde /s
  485.  
  486. or, you could copy it to a different disk:
  487.  
  488.    xcopy c:\southsde d:\southsde /s
  489.  
  490. ---------------------------------------------------------------------
  491.  
  492. If you are short of disk space then you can setup a copy of your PMMail
  493. directories with only some of the data.
  494.  
  495. For example, assume you have 4 e-mail accounts.  Again, assuming a
  496. subdirectory called Test, first copy the Tools directory:
  497.  
  498.    mkdir c:\test
  499.    mkdir c:\test\southsde
  500.    xcopy c:\southsde\tools c:\test\southsde\tools /s
  501.  
  502. Then copy the files in the PMMail directory:
  503.  
  504.    mkdir c:\test\southsde\pmmail
  505.    copy c:\southsde\pmmail\*.* c:\test\southsde\pmmail
  506.  
  507. Finally copy one of your accounts:
  508.     (the two lines below should be on one line)
  509.  
  510.    xcopy c:\southsde\pmmail\accnt_0.act
  511.               c:\test\southsde\pmmail\accnt_0.act /s
  512.  
  513. ---------------------------------------------------------------------
  514.  
  515. When you are done creating a test directory you can then run the archiver
  516. from the test directory without any fear of damaging your live files.
  517.  
  518. __________________________________________________________________________
  519.  
  520. So You Need To Restore A File
  521. -----------------------------
  522.  
  523. Restoring a file consists of several steps.  The only requirement is that
  524. the account directory already be created (this limitation will be removed
  525. in a later release).
  526.  
  527. It is strongly recommended that if you are restoring a limited number of
  528. files that you use the /R (allRequired) mode.
  529.  
  530. Files are normally restored to a new folder called "Restored Files" (which
  531. will be created if it doesn't exist) in each directory.  If you wish, you
  532. can specify the /o (originalLocation) option to put the files back into
  533. their original locations in the account directories.
  534.  
  535. You have several options depending upon how much you know about the file
  536. you are looking for.
  537.  
  538. What you know
  539. -------------
  540. If you know the account directory and the folder the file was in,
  541. and who the file was from:
  542.  
  543. Command you can use
  544. -------------------
  545. archiver /r /R /a acct_0.act /f folder.dir /F name@addr.com archive.zip
  546.  
  547. What it does
  548. ------------
  549. /r     Specify restore mode.
  550. /R     Specify the allRequired mode.
  551. /a     Specify account directory being restored.
  552. /f     Specify the folder directory being restored.
  553. /F     Specify the e-mail address in the messages being restored.
  554.  
  555.  
  556. What you know
  557. -------------
  558. If you know the account directory and folder directory:
  559.  
  560. Command you can use
  561. -------------------
  562. archiver /r /R /a acct_0.act /f folder.dir /Q   archive.zip
  563.  
  564. What it does
  565. ------------
  566. /r     Specify restore mode.
  567. /R     Specify the allRequired mode.
  568. /a     Specify account directory being restored.
  569. /f     Specify the folder directory being restored.
  570. /Q     Specify query mode.  This will ask you before restoring each
  571.        file.
  572.  
  573. __________________________________________________________________________
  574.  
  575. Command Line Examples
  576. ---------------------
  577.  
  578. Example 1 - Archiving
  579. ---------------------
  580.  
  581. archiver /V 2 /p d:\src\pmmail /a jbayer0.act /a jbayer2.act /A 100 arch???
  582.  
  583. What it does:
  584.  
  585. /V       Verbose level of 2.
  586. /p       Specify the source directory for PMMail.
  587. /a       Specify the account directory jbayer0.act to back up.
  588. /a       Specify the account directory jbayer2.act to back up.
  589. /A       Specify to back up files which are more than 100 days old.
  590.  
  591. Create a numerically sequenced archive file beginning with arch001.zip
  592.  
  593.  
  594. Example 2 - Restoring files
  595. ---------------------------
  596.  
  597. archiver /Q /r arch001.zip
  598.  
  599. What it does:
  600.  
  601. /Q       Query mode.  Ask before restoring a file.
  602. /r       Restore mode.  Restore files from the specified archive file..
  603.  
  604.  
  605. Example 3 - Reindexing
  606. ----------------------
  607. archiver /I
  608.  
  609. What it does:
  610.  
  611. /I       Reindex all folders.
  612.  
  613.  
  614. __________________________________________________________________________
  615.  
  616. Configuration File Examples
  617. ---------------------------
  618.  
  619. Example 1 - Archiving
  620. ---------------------
  621.  
  622. archivefile arch???
  623. pmmailDirName d:\src\pmmail
  624. accountDir jbayer0.act
  625. accountDir jbayer2.act
  626. fileAge 100
  627. archiveDay Fri
  628.  
  629. What it does:
  630.  
  631. Create a numerically sequenced archive file beginning with arch001.zip.
  632. Specify the source directory for PMMail.
  633. Specify the account directory jbayer0.act to back up.
  634. Specify the account directory jbayer2.act to back up.
  635. Specify to back up files which are more than 100 days old.
  636. Specify that archives are to be done on Fridays only.
  637.  
  638.  
  639. Example 2 - Archiving using command line syntax
  640. -----------------------------------------------
  641.  
  642. archivefile arch???
  643. /p d:\src\pmmail
  644. /a jbayer0.act
  645. /a jbayer2.act
  646. /A 100
  647. archiveDay      Fri
  648.  
  649. What it does:
  650.  
  651. This does the same as example 1, although using the command line syntax
  652. in the configuration file.
  653.  
  654. __________________________________________________________________________
  655.  
  656. Multiple folder filters
  657. -----------------------
  658.  
  659. You have the following directory structure:
  660.  
  661. my.act/
  662.        main_0.fld/
  663.                   test_0.fld/
  664.                   pers_0.fld/
  665.                   spam_0.fld/
  666.                              read_0.fld/
  667.                              unread.fld/
  668.                   beta_0.fld/
  669.                              mine_0.fld/
  670.                                         high_0.fld
  671.                              read_0.fld/
  672.                                         high_0.fld
  673.  
  674. You want to backup the following:
  675.  
  676.    All of beta_0.fld/mine_0.fld
  677.    all of beta_0.fld/read_0.fld/high_0.fld
  678.    All of pers_0.fld
  679.  
  680. Command line syntax (line is split on multiple lines for clarity)
  681. -------------------
  682.  
  683. archiver /f beta_0.fld\mine_0.fld
  684.          /f beta_0.fld\mine_0.fld\high_0.fld
  685.          /f beta_0.fld\read_0.fld\high_0.fld
  686.          /f pers_0.fld
  687.  
  688. Configuration File
  689. ------------------
  690.  
  691. NestedFolder   yes
  692. folderDir beta_0.fld\mine_0.fld
  693. folderDir beta_0.fld\read_0.fld\high_0.fld
  694. folderDir pers_0.fld
  695.  
  696.  
  697. What it does
  698. ------------
  699.  
  700. Each folderDir (/f) filter will cause the all the message files
  701. in the corresponding folder to be archived.
  702.  
  703. The configuration file has the additional option "NestedFolder"
  704. available, which will let all folders beneith the specified folder
  705. be archived.
  706. __________________________________________________________________________
  707.  
  708. External Exit/Hook Examples
  709. ---------------------------
  710.  
  711. This is an example of how to use an external command file to
  712. call the archiver from within PMMail.
  713.  
  714. For OS/2 you will create a Rexx command file.  For Windows you
  715. will create a batch file.
  716.  
  717.  
  718. OS/2 Rexx command file.
  719.  
  720.    Place the following into the entry field:
  721.       pmclose.cmd
  722.  
  723. DOS/Windows batch file
  724.    Place the following into the entry field:
  725.       pmclose.bat
  726.  
  727. In the pmclose.cmd/pmclose.bat file:
  728.  
  729.       archiver /V 2 /A 100 /a jbayer0.act
  730.       archiver /V 2 /A 10 /a jbayer1.act
  731.       archiver /i alias
  732.       archiver /I
  733.  
  734. What it does:
  735.  
  736.    This calls the archiver four times.  The first time it will
  737.    archive all files in the jbayer0.act directory which are at
  738.    least 100 days old:
  739.  
  740.       /A 100         Specifies file age
  741.       /a jbayer0.act Specifies account directory
  742.  
  743.    The second time it will archive all files in the jbayer1.act which
  744.    are at least 10 days old:
  745.  
  746.       /A 10          Specifies file age
  747.       /a jbayer1.act Specifies account directory
  748.  
  749.    The third time it will sort the address book file by alias:
  750.  
  751.       /i alias
  752.  
  753.    The fourth time it will reindex all folders in the PMMail directory:
  754.       /I
  755. __________________________________________________________________________
  756.  
  757. InfoZip and InfoUnzip
  758. ---------------------
  759.  
  760. PMMail archiver depends on the available of the InfoZip programs "Zip" and
  761. "UnZip".  These are Freeware, compatible programs with the PKZip series
  762. of programs.  Information on them and links to the executables are
  763. located at:
  764.  
  765.       http://www.cdrom.com/pub/infozip/
  766.  
  767. As of Feb. 5, 1998 the files you will need to download are:
  768.  
  769.    For OS/2:
  770.  
  771.              unz532x2.exe     UnZip 5.32, OS/2 self-extr. exes (32-bit)
  772.              zip22x2.zip      Zip 2.2, OS/2 32-bit exes (no encryption)
  773.  
  774.  
  775.    For Windows-95/NT:
  776.  
  777.              zip22xN.zip       Zip 2.2, NT/95 Intel exes (no encryption)
  778.              unz532xN.exe      UnZip 5.32, NT/95 Intel exes, self-extract
  779.  
  780. __________________________________________________________________________
  781.  
  782. Program overview
  783. ----------------
  784.  
  785. PMMail Archiver works by examining all the files in the specified directory
  786. structure and checking the specified parameters against each file.
  787.  
  788. The following steps are taken during the archive process:
  789.  
  790.    1. Verify all the specified options for validity.
  791.    2. For each account specified, or all accounts if none specified:
  792.       a. Read the directory and get list of all folders.
  793.       b. Read each folder and get list of files.
  794.       c. Read the folder.bag file in each folder.
  795.       d. Read each file to get file information.
  796.       e. Check each file against filter criteria.  Eliminate files
  797.          which don't match.
  798.    3. Create a list of files which are to be archived.
  799.    4. Create a file BACKUP.BAG to contain folder.bag entries for each
  800.       file being archived.  Store full path relative to the PMMail
  801.       directory.
  802.    5. Call InfoZip to archive selected files.
  803.    6. If InfoZip was successful and the files are to be deleted:
  804.       a. Rewrite the folder.bag file for each folder, removing those files
  805.          from the bag file which were archived.
  806.       b. Delete the files in each folder which were archived.
  807.  
  808.  
  809. The following steps are taken during the restore process:
  810.  
  811.    1. Verify all the specified options for validity.
  812.    2. Verify the zip file exists.
  813.    3. Unzip the backup.bag file from the zip file.  If it is not there
  814.       then exit with an error.
  815.    4. Read the backup.bag file to get list of files contained in backup.
  816.    5. Filter the list of files using the specified parameters.
  817.    6. Restore the files.  If query mode is active then query the user
  818.       before restoring each file.
  819. __________________________________________________________________________
  820.  
  821. Registration Information
  822. ------------------------
  823.  
  824. This program is Shareware.  You are allowed to use it for a reasonable
  825. amount of time to evaluate it.  Please do not use it beyond the
  826. evaluation period (30 days) without registering it. This shareware
  827. version of PMMail Archiver has been furnished for your evaluation.  If
  828. you find the product useful and wish to continue to use it, please take
  829. the time to register your product.  Complete registration information is
  830. located in the REGISTER file
  831. __________________________________________________________________________
  832.  
  833. Support
  834. -------
  835.  
  836. Support is provided by the author.  If you have any problems please contact
  837. me at:
  838.  
  839.   Jonathan B. Bayer
  840.   PO Box 561
  841.   Edison, NJ   08818-0561
  842.  
  843.   Email: Jonathan_Bayer@bigfoot.com
  844.   Web:   http://members.xoom.com/jbayer/archiver
  845.  
  846. Mention PMMail Archiver in the subject of your message for faster support.
  847. Please provide your serial # and all relevant information.
  848.  
  849. __________________________________________________________________________
  850.  
  851.