@database ReplyWizard.guide

@node Main "ReplyWizard v1.4"
@next Copy


                            @{b}@{u}@{fg highlight}ReplyWizard v1.4@{ub}@{uu}@{fg text}


         A tool for the Universal Message System, with this you
                   can generate automatically replys.

                      Copyright ©1995 Andreas Baum


 @{" Copyright " link Copy}                  Copyright and other legal stuff
 @{" Author " link Author}                     How to reach the author

 @{" Introduction " link Intro}               What is ReplyWizard ?
 @{" Installation " link Install}               Installation of ReplyWizard
 @{" Configuration " link Config}              Configuration of ReplyWizard
 @{" Starting ReplyWizard " link Start}       Starting ReplyWizard
 @{" Output " link Output}                      Output of ReplyWizard

 @{" PGP Key " link PGP}                    PGP PublicKey

 @{" History " link History}                    The development of ReplyWizard
 @{" Credits " link Credits}                    The Author wish to thank...
 @{" Bugreports etc. " link Bugs }            Where to send bugs and features ?


                 SORRY, but my English is horrific :-(

@endnode

@node Copy "Copyright"
@next Author
@prev Main


@{b}@{u}Copyright and other legal stuff@{ub}@{uu}


@{b}Copyright:@{ub}

Copyright ©1995 Andreas Baum

   Permission is granted to make and distribute verbatim copies of  this
manual  provided  the  copyright  notice  and this permission notice are
preserved on all copies.

   Neither the programs nor the source code (nor parts  of  it)  may  be
included  or used in commercial programs unless by written permission of
the author.

@{b}No Warranty:@{ub}

   No Warranty of any kind is given that the program described  in  this
document  are  100%  reliable.  You  are using this material at your own
risk. The author can not be made responsible for  any  damage  which  is
caused by using these program.

@{b}Distribution:@{ub}

   This package is @{b}freely distributable@{ub}. It may  be  transfered  to  any
media  used  for distributing free software. This includes public domain
series, CDROMs, FTP servers and mailboxes.

   If you want to distribute this program  you  must  use  the  original
distribution  archives.  The  author can not be made responsible for any
damage if the software was damaged by modifying the archive.

   There is no limit for the  fee  taken  for  this  media  like  disks,
streamer  tapes,  CDROMs or for copying. It must only be clear that this
fee is taken for the media and the copying and  @{b}not@{ub}  for  the  software.
Limitations  of  the fee have proved to be senseless in past because the
fee was not lowered but the files were removed from the original medias.

   Although the author do not restrict  the  cost  for  distribution  he
want to tell his opinion abouth this topic:

   @{b}*@{ub} This software package should be available for everybody without any
     fee if it is possible.

   @{b}*@{ub} If you purchased this software the normal way from a Public domain
     distributor on a disk and you have payed more than 5,-DM or $5,-US
     for it you have  definitely  overpayed.  You  should  look  for  a
     cheaper source for Public-Domain software as soon as possible.

@{b}Limitations of Usage:@{ub}

   None of the program nor the source code (nor parts  of  it)  may  be
used  on  any  machine  which  is  used  for the research, development,
construction, testing  or  production  of  weapons  or  other  military
applications. This also includes any machine which is used for training
persons for any of the above mentioned purposes.

@endnode

@node Author "Author"
@next Intro
@prev Copy


@{b}@{u}Address of the Author@{ub}@{uu}

The author can be reached at the following address:

     @{b}Andreas Baum:@{ub}

     Snail-Mail:
      Eugen-Roth-Straße 25
      92318 Neumarkt
      FR Germany

     E-Mail:
      fatso@turtle.insider.sub.de
      Andreas Baum 2:2490/1370.6@fidonet
     
     Telephone:
      +49-9181-20950

@endnode

@node Intro "Introduction"
@next Install
@prev Author


@{b}@{u}What is ReplyWizard?@{ub}@{uu}

ReplyWizard is a tool for the @{b}Universal Message System@{ub},  with  this  you
can generate automatically replys.

Following @{b}features@{ub} were supported:

   @{b}*@{ub} Scan the private messages:
   @{b}*@{ub} Scan the private messages: folder
   @{b}*@{ub} Generate replys  if  the  attribute  receipt-request  resp.  audit-
     request is set. ReplyWizard also supports replyaddress after receipt-request
     resp.  audit-request. Supported formats:
       RECEIPT-REQUEST="<NAME>,<ADDRESS>"
       RECEIPT-REQUEST="<ADDRESS>"
       RECEIPT-REQUEST="<NAME1>,<ADDRESS1>;<ADDRESS2>;...;<NAMEn>,<ADDRESSn>"
       RECEIPT-REQUEST "<NAME>,<ADDRESS>"
       RECEIPT-REQUEST "<ADDRESS>"
       RECEIPT-REQUEST "<NAME1>,<ADDRESS1>;<ADDRESS2>;...;<NAMEn>,<ADDRESSn>"
       Or AUDIT-REQUEST instead RECEIPT-REQUEST. One mail for every user will  be
       created so you can mix RFC- and Fidoaddress.
   @{b}*@{ub} Generate replys  if  the  attribute  receipt-request  resp.  audit-
     request isn't set (only messages with the  attribute  receipt  were
     not replyed).
   @{b}*@{ub} ReplyWizard can configure global for all users or  local  to  every
     user.
   @{b}*@{ub} You can use your real- or an imaginationname.
   @{b}*@{ub} Foldername for the replys is configureable.
   @{b}*@{ub} Configureable subject, messagetext, replyname and replyaddress.
   @{b}*@{ub} Known variables from IntuiNews  were  partially  supported  in  the
     subject and the messagetext (%s subject, %d date and time, %n  name
     of the sender).
   @{b}*@{ub} A file can used for the messagetext.
   @{b}*@{ub} Archivbit can be set.
   @{b}*@{ub} Replyed messages keep marked as new.
   @{b}*@{ub} Userstatusbit configureable.
   @{b}*@{ub} Program uses the @{b}Guidelines of a  standardized  login-procedure  in@{ub}
     @{b}UMS-programs@{ub}.

@endnode

@node Install "Installation"
@next Config
@prev Intro


@{b}@{u}Installation@{ub}@{uu}

Copy the file @{b}ReplyWizard@{ub} to the other UMS-bin's.

@endnode

@node Config "Configuration"
@next Start
@prev Install


@{b}@{u}Configuration@{ub}@{uu}

   ReplyWizards's  setup  is  mainly  controlled  by UMS   configuration
variables.

   For the configuration you should use ConfUMS  v1.1a  (UMS v10)  resp.
v1.2 (UMS v11).

@{b}UMS configuration variables:@{ub}

   Applications using UMS have  the  possibility  to  access  their  own
variables  in  the  main UMS configuration file. This file is located in
the same directory as the messagebase. Because ReplyWizard  makes  heavy
use of this feature it does not require an own configuration file.

@{b}@{fg highlight}Attention:@{fg text}@{ub}  Because  AmigaGuide  and  MultiView  react  differently   on
backslashes  you  may see two backslashes. Of course you should use only
one in the UMS configuration.

Configuration variables, @{b}global@{ub} or @{b}local@{ub}:

 @{" Replywizard.MaxMsgSize " link MaxMsgSize}
     memorysize which used for replys.

 @{" Replywizard.UserStatusBit " link UserStatusBit}
     Used userstatusbit to mark messages as replyed.

 @{" ReplyWizard.ReplyFolder " link ReplyFolder}
     Name of the folder for the replyed messages.

 @{" ReplyWizard.ArchivBit " link ArchivBit}
     Should the archivbit set ?

 @{" ReplyWizard.Folders " link Folders}
     List of folders which were scanned. (Replys were only generated  if
     the attribute receipt-request resp. audit-request is set.)

 @{" ReplyWizard.ForceFolders " link ForceFolders}
     List of folders which were scanned. (Replys were always  generated.
     Exeption: The attribute receipt is set.)

 @{" ReplyWizard.WizardName " link WizardName}
     Name of the sender.

 @{" ReplyWizard.Name " link Name}
     Name of the user for the field @{b}Reply-To:@{ub}.

 @{" ReplyWizard.Address " link Address}
     Address of the User for the field @{b}Reply-To:@{ub}.

 @{" ReplyWizard.Subject " link Subject}
     Subject for the reply.

 @{" ReplyWizard.Msg " link Msg}
     Text for the reply.

@endnode

@node MaxMsgSize "ReplyWizard.MaxMsgSize"
@toc Config
@next UserStatusBit
@prev Config


@{b}@{u}ReplyWizard.MaxMsgSize@{ub}@{uu}

   You can use this variable to define the memorysize for replys.

@{b}Example:@{ub}

     @{b}@{fg highlight}UMS v10@{fg text}@{ub}

     ReplyWizard.MaxMsgSize = "16384"

     @{b}@{fg highlight}UMS v11@{fg text}@{ub}

     ( ReplyWizard.MaxMsgSize "16384" )

@{b}Default:@{ub}

     "8192"

@{b}Remark:@{ub}

     This variable is optional.

@endnode

@node UserStatusBit "ReplyWizard.UserStatusBit"
@toc Config
@next ReplyFolder
@prev MaxMsgSize


@{b}@{u}ReplyWizard.UserStatusBit@{ub}@{uu}

   You can use  this  variable  to  define  the  userstatusbit  to  mark
messages  as  replyed.  This variable is necessary for the compatibility
with other UMS tools which uses the free userstatusbits, too or  if  UMS
needs  a  free  userstatusbit  in  the  future.  You  can choose between
userstatusbit 0, 1, 2, 3, 13, 14.

@{b}Example:@{ub}

     @{b}@{fg highlight}UMS v10@{fg text}@{ub}

     ReplyWizard.UserStatusBit = "2"

     @{b}@{fg highlight}UMS v11@{fg text}@{ub}

     ( ReplyWizard.UserStatusBit "2" )

@{b}Default:@{ub}

     "0"

@{b}Remark:@{ub}

     This variable is optional.

@endnode

@node ReplyFolder "ReplyWizard.ReplyFolder"
@toc Config
@next ArchivBit
@prev UserStatusBit


@{b}@{u}ReplyWizard.ReplyFolder@{ub}@{uu}

   You can use this variable to define the foldername where all  replyed
messages come in.

@{b}Example:@{ub}

     @{b}@{fg highlight}UMS v10@{fg text}@{ub}

     ReplyWizard.ReplyFolder = "MailReplys"

     @{b}@{fg highlight}UMS v11@{fg text}@{ub}

     ( ReplyWizard.ReplyFolder "MailReplys" )

@{b}Default:@{ub}

     "mailreplys"

@{b}Remark:@{ub}

     This variable is optional.

@endnode

@node ArchivBit "ReplyWizard.ArchivBit"
@toc Config
@next Folders
@prev ReplyFolder


@{b}@{u}ReplyWizard.ArchivBit@{ub}@{uu}

   You can use this variable to define if the archivbit should be set or
not.

@{b}Example:@{ub}

     @{b}@{fg highlight}UMS v10@{fg text}@{ub}

     ReplyWizard.ArchivBit = "Yes"

     @{b}@{fg highlight}UMS v11@{fg text}@{ub}

     ( ReplyWizard.ArchivBit "Yes" )

@{b}Default:@{ub}

     "No"

@{b}Remark:@{ub}

     This variable is optional.

@endnode

@node Folders "ReplyWizard.Folders"
@toc Config
@next ForceFolders
@prev ArchivBit


@{b}@{u}ReplyWizard.Folders@{ub}@{uu}

   You can use this variable to define the folders  which  were  scanned
for  new,  nonreplyed  messages with the attribute receipt-request resp.
audit-request.

@{b}Example:@{ub}

     @{b}@{fg highlight}UMS v10@{fg text}@{ub}

     ReplyWizard.Folders = "InterNET
     FidoNET
     AmigaNET"

     @{b}@{fg highlight}UMS v11@{fg text}@{ub}

     ( ReplyWizard.Folders "InterNET\\nFidoNET\\nAmigaNET\\n" )

@{b}Default:@{ub}

     none

@{b}Remark:@{ub}

     This variable is optional.

@endnode

@node ForceFolders "ReplyWizard.ForceFolders"
@toc Config
@next WizardName
@prev Folders


@{b}@{u}ReplyWizard.ForceFolders@{ub}@{uu}

   You can use this variable to define the folders  which  were  scanned
for  new,  nonreplyed  messages with unset attribute receipt. @{b}Attention:@{ub}
The use of this variable were recommended only well  versed  UMS  users,
because you can easy create endless replyes if the attribute receipt was
lost.

@{b}Example:@{ub}

     @{b}@{fg highlight}UMS v10@{fg text}@{ub}

     ReplyWizard.ForceFolders = "BugReports
     Important"

     @{b}@{fg highlight}UMS v11@{fg text}@{ub}

     ( ReplyWizard.ForceFolders "BugReports\\nImportant\\n" )

@{b}Default:@{ub}

     none

@{b}Remark:@{ub}

     This variable is optional.

@endnode

@node WizardName "ReplyWizard.WizardName"
@toc Config
@next Name
@prev ForceFolders


@{b}@{u}ReplyWizard.WizardName@{ub}@{uu}

   You can use this variable to define a imaginationname of the  sender.
(For this user a entry in the UMS.config is required !) If this variable
wasn't defined the realname will be used.

@{b}Example:@{ub}

     @{b}@{fg highlight}UMS v10@{fg text}@{ub}

     ReplyWizard.WizardName = "ReplyWizard"

     @{b}@{fg highlight}UMS v11@{fg text}@{ub}

     ( ReplyWizard.WizardName "ReplyWizard" )

@{b}Default:@{ub}

     none (the realname is used)

@{b}Remark:@{ub}

     This variable is optional.

@endnode

@node Name "ReplyWizard.Name"
@toc Config
@next Address
@prev WizardName


@{b}@{u}ReplyWizard.Name@{ub}@{uu} resp. @{b}@{u}ReplyWizard.Name.<Folder>@{ub}@{uu}

   You can  use  this  variable  to  define  the  replyname.  (see  also
IntuiNewsGuide 'The Mail Window/String Gadgets/Reply-To').

@{b}Examples:@{ub}

     @{b}@{fg highlight}UMS v10@{fg text}@{ub}

     ReplyWizard.Name = "Andreas Baum"

     ReplyWizard.Name.FidoNET = "Andreas Baum"

     @{b}@{fg highlight}UMS v11@{fg text}@{ub}

     ( ReplyWizard.Name "Andreas Baum" )

     ( ReplyWizard.Name.FidoNET "Andreas Baum" )

@{b}Default:@{ub}

     none

@{b}Remark:@{ub}

     This variable is optional.

@endnode

@node Address "ReplyWizard.Address"
@toc Config
@next Subject
@prev Name


@{b}@{u}ReplyWizard.Address@{ub}@{uu} resp. @{b}@{u}ReplyWizard.Address.<Folder>@{ub}@{uu}

   You can use this variable  to  define  the  replyaddress.  (see  also
IntuiNewsGuide 'The Mail Window/String Gadgets/Reply-To').

@{b}Examples:@{ub}

     @{b}@{fg highlight}UMS v10@{fg text}@{ub}

     ReplyWizard.Address = "2:2490/1370.6@FidoNET"

     ReplyWizard.Address.InterNET = "fatso@turtle.insider.sub.de"

     @{b}@{fg highlight}UMS v11@{fg text}@{ub}

     ( ReplyWizard.Address "2:2490/1370.6@FidoNET" )

     ( ReplyWizard.Address.InterNET "fatso@turtle.insider.sub.de" )

@{b}Default:@{ub}

     none

@{b}Reamrk:@{ub}

     This variable is optional.

@endnode

@node Subject "ReplyWizard.Subject"
@toc Config
@next Msg
@prev Address


@{b}@{u}ReplyWizard.Subject@{ub}@{uu} resp. @{b}@{u}ReplyWizard.Subject.<Folder>@{ub}@{uu}

   You can use this variable to define the subject for  the  reply.  The
following known variables were supported:

     "%%" for the per cent sign.
     "%d" for the creation date and time of the original message.
     "%n" for the name of the original sender.
     "%s" for the subject of the original sender.

@{b}Examples:@{ub}

     @{b}@{fg highlight}UMS v10@{fg text}@{ub}

     ReplyWizard.Subject = "Reply your Mail: %s"

     ReplyWizard.Subject.FidoNET = "Reply your FidoMail: %s"

     @{b}@{fg highlight}UMS v11@{fg text}@{ub}

     ( ReplyWizard.Subject "Reply your Mail: %s" )

     ( ReplyWizard.Subject.FidoNET "Reply your FidoMail: %s" )

@{b}Default:@{ub}

     none

@{b}Remark:@{ub}

     This variable is required.

@endnode

@node Msg "ReplyWizard.Msg"
@toc Config
@next Config
@prev Subject


@{b}@{u}ReplyWizard.Msg@{ub}@{uu} resp. @{b}@{u}ReplyWizard.Msg.<Folder>@{ub}@{uu}

   You can use this variable to define the text or the filename (use a @{b}$@{ub}
in  front  of the filename) for the reply. The following known variables
were supported:

     "%%" for the per cent sign.
     "%d" for the creation date and time of the original message.
     "%n" for the name of the original sender.
     "%s" for the subject of the original sender.

@{b}Examples:@{ub}

     @{b}@{fg highlight}UMS v10@{fg text}@{ub}

     ReplyWizard.Msg = "Hello %n,*n
     I received your Mail about %s at %d.
     I will answer you in a few days.*n
     Bye, Andreas"

     ReplyWizard.Msg.InterNET = "Hi %n,*n
     I received your InterNET-Mail about
     %s
     at %d.*n
     bye, Andreas (fatso@turtle.insider.sub.de)"

     ReplyWizard.Msg.AmigaNET = "$UMS:Texts/PGPFingerPrint"

     @{b}@{fg highlight}UMS v11@{fg text}@{ub}

     ( ReplyWizard.Msg
         "Hello %n,\\n"
         "\\n"
         "I received your Mail about %s at %d.\\n"
         "I will answer you in a few days.\\n"
         "\\n"
         "Bye, Andreas\\n"
     )

     ( ReplyWizard.Msg.InterNET =
         "Hi %n,\\n"
         "\\n"
         "I received your InterNET-Mail about\\n"
         "%s\\n"
         "at %d.\\n"
         "\\n"
         "bye, Andreas (fatso@turtle.insider.sub.de)\\n"
     )

     ( ReplyWizard.Msg.AmigaNET "$UMS:Texts/PGPFingerPrint" )

@{b}Default:@{ub}

     none

@{b}Remark:@{ub}

     This variable is required.

@endnode

@node Start "Starting ReplyWizard"
@next Output
@prev Config


@{b}@{u}Starting from a shell@{ub}@{uu}

   If you start ReplyWizard from a shell you may  supply  the  following
arguments:

@{b}NAME/A@{ub}
     The name of the UMS user.

@{b}PASSWORD/A@{ub}
     The password for this user. The password is case sensitive.

@{b}SERVER/K@{ub}
     The UMS server to use. You must use the keyword @{b}SERVER@{ub} in front  of
     this argument.

@{b}Example:@{ub}

     1> ReplyWizard "Andreas Baum" Secret

@endnode

@node Output "Output"
@next PGP
@prev Start


@{b}@{u}Output of ReplyWizard@{ub}@{uu}

@{b}.@{ub} = New mail but no RECEIPT-REQUEST or AUDIT-REQUEST found.
@{b}+@{ub} = Create receiptmail with from- replyname and from- replyaddress.
@{b}>@{ub} = Found a new mail with a 'attributereceipt'.
@{b}*@{ub} = Create receiptmail with 'attributename and -address'.
@{b}!@{ub} = New mail but already replyed.

@endnode

@node PGP "PGP"
@next History
@prev Output


@{b}@{u}PGP PublicKey@{ub}@{uu}

   Below you will find my public key. Enter 'PGP  ReplyWizard.guide'  to
decode  it  and  add my key to your PGP keyring. To verify my signature,
now enter 'PGP ReplyWizard ReplyWizard'. If  you  don't  trust  the  key
below you can still contact me via E-Mail to ask for the PGP fingerprint
(you have to use PGPFINGERPRINT as subject).

-----BEGIN PGP PUBLIC KEY BLOCK-----
Version: 2.3a.5

mQBNAi6O4SwAAAECAOHErvV7mRB/trVpCq6pf5Wt7RxgKEhe6N+0hpkNos4beVo1
j3Uzh1nax/x94Bte2lp0vrv5ttnDik/k+aUPo4kABRG0KkFuZHJlYXMgQmF1bSA8
ZmF0c29AdHVydGxlLmluc2lkZXIuc3ViLmRlPg==
=bZBx
-----END PGP PUBLIC KEY BLOCK-----

@endnode

@node History "History"
@next Credits
@prev PGP


@{b}@{u}History@{ub}@{uu}

   ReplyWizard v1.0

   @{b}*@{ub} First internal version

   ReplyWizard v1.1

   @{b}*@{ub} First public version

   ReplyWizard v1.2

      BUG: If you didn't use the userstatusbit 0 the  userstatusbit  was
           set but it wasn't checked correctly. So replys were generated
           until the message was read and marked as old.

      BUG: Enforcerhit, which occures if the  attributeline  was  empty,
           removed.

      BUG: corrected some bugs in the german guide.

      NEW: You can answer with your real- or with an imaginationname.

      NEW: A file can used for the messagetext.

      NEW: The maximum size of a message will be  taken  from  the  UMS-
           configvariable @{b}MaxMsgSize@{ub}.

   @{b}*@{ub} Second public version

   ReplyWizard v1.3

      BUG: If the configvariable ReplyWizard.Msg resp. Reply-Wizard.Msg.
           <Folder> was changed this ConfUMS from a multi line text to a
           file and no single line was taken, then ReplyWizard  searches
           for the filename with return and the file couldn't found.

      NEW: Localizised

      NEW: English guide

   @{b}*@{ub} Third public version

   ReplyWizard v1.4

      BUG: If you use a file as messagetext (for example  a  histoyfile)
           it was very, very slow. Now it's about 1000 times faster!

      NEW: ReplyWizard checks the attributefield for the replyaddress.

      NEW: New configvariable ReplyWizard.MaxMsgSize. ReplyWizard < v1.4
           uses the global configvariable MaxMsgSize from UMS, but  user
           with low memory have problems with the memoryusage.

   @{b}*@{ub} Fourth public version

@endnode

@node Credits "Credits"
@next Bugs
@prev History


@{b}@{u}Credits@{ub}@{uu}

@{b}Martin Horneffer@{ub}
     for the Universal Message System

@{b}Markus Stipp@{ub} and @{b}Matthias Scheler@{ub}
     for the mail- and newsreader IntuiNews

@{b}André Schenk@{ub}
     for UMSFido

@{b}Marc Jackisch@{ub}
     for UMSZer

@{b}Olaf Peters@{ub}
     for ConfUMS

and all other UMS-programers.

@endnode

@node Bugs "Bugreports etc."
@prev Credits


@{b}@{u}Where to send bug reports and feature@{ub}@{uu}


   Bug reports and feature requests should go to this address:

     @{b}Andreas Baum:@{ub}
     
     E-Mail:
      fatso@turtle.insider.sub.de
      andreas_baum@p38.amiga_inside.schiele-ct.de
      Andreas Baum 2:2490/1370.6@fidonet

     Telephone:
      +49-9181-20950

@endnode