home *** CD-ROM | disk | FTP | other *** search
/ The Elite Hackers Toolkit / TheEliteHackersToolkitVolume1_1998.rar / HACKERS.BIN / appcraks / DSI_CM11.ZIP / README.TXT < prev    next >
Text File  |  1990-01-01  |  11KB  |  315 lines
  1. CGIMailer for Windows 95/NT4.0
  2. May 1998 version 1.11
  3.  
  4. Author:
  5. Goran Boban
  6. gboban@cursor.hr
  7.  
  8.  
  9.     DISCLAIMER
  10.  
  11.     THIS SOFTWARE AND ALL THE ACCOMPANYING FILES ARE PROVIDED "AS IS" AND 
  12.     WITHOUT ANY WARRANTIES EXPRESSED OR IMPLIED INCLUDING BUT NOT LIMITED
  13.     TO IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 
  14.     PURPOSE. 
  15.  
  16.  
  17.  
  18.     LIMITATION OF LIABILITY
  19.  
  20.     AUTHOR SHALL NOT BE LIABLE FOR ANY DAMAGES SUFFERED BY LICENSEE OR ANY
  21.     THIRD PARTY AS A RESULT OF USING SOFTWARE. IN NO EVENT WILL AUTHOR BE
  22.     LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR DIRECT, INDIRECT,
  23.     SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES, HOWEVER  CAUSED
  24.     AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR
  25.     INABILITY TO USE SOFTWARE, EVEN IF AUTHOR HAS BEEN ADVISED OF THE
  26.     POSSIBILITY OF SUCH DAMAGES.      
  27.  
  28.  
  29.     1. Description
  30.     --------------
  31.  
  32. CGIMailer is an CGI (Common Gateway Interface) program wich will recive input from
  33. web form and send mail.
  34.  
  35. CGIMailer supports:
  36.     - Required variables
  37.     - Template based e-mail messages
  38.     - Template based response pages
  39.     - Customisable error reports
  40.  
  41. NOTE: There must be an SMTP server accessable from your server.
  42.  
  43.  
  44.  
  45.  
  46.     2. Installation
  47.     ---------------
  48.  
  49. To install CGIMailer just copy CGIMail.exe to cgi-bin directory of your web server or any
  50. other directory in wich your server will allow execute access. Please see your servers
  51. documentation for more information.
  52.  
  53.  
  54.  
  55.  
  56.     3. Using CGIMailer
  57.     ------------------
  58.  
  59. Please see history.txt for list of changes since version 1.00.
  60.  
  61. CGIMailer is controlled with configuration files (Every form that uses CGIMailer can
  62. have its own configuration file).
  63. You can setup following variables in configuration file:
  64.  
  65. TEMPLATE    REQUIRED    is relative path (from CGIMail.exe) to template file
  66.                 used to create response page if operation succeeds.
  67.                 If this variable is not set CGIMailer will generate an
  68.                 error.
  69.  
  70. ERRTEMPLATE    relative path to template file if an error ocures. If this variable
  71.         is not set CGIMailer will display an built-in error message.
  72.  
  73. MSGTEMPLATE    template for creating mail message. If this variable is not set CGIMailer
  74.         will create message of following form:
  75.             VARIABLE1=VALUE1
  76.             VARIABLE2=VALUE2
  77.             ...
  78.         Where VARIABLE1, VARIABLE2 etc. are names of input fields in your web form.
  79.  
  80. DEBUG        If this variable is set to YES (DEBUG=YES) CGIMailer will send an text
  81.         response with transcription of comunication with SMTP server.
  82.         Othervise it will create response page based on file pointed in
  83.         TEMPLATE variable.
  84.  
  85. GATEWAY        Name of smtp server (smtp.server.com for example) to use for sending mail.
  86.         If this variable is not set CGIMailer will assume localhost.
  87.  
  88. PORT        Port number of SMTP service on SMTP server. By default it is 25.
  89.  
  90. FROM        E-mail address of sender. If this variable is not set CGIMailer will
  91.         assume an addres of form CURRENT_USER@NAME_OF_LOCAL_MACHINE.
  92.         You should set this variable in most cases.
  93.  
  94. TO        REQUIRED    E-mail addres (or list of addresses) of recipient(s).
  95.                 If this variable is not set CGIMailer will generate an
  96.                 error. E-mails have to be separated with space (" ").
  97.  
  98. CC        List of addresses to send carbon copy of message (displayed in Cc: field
  99.         of message).
  100.  
  101. BCC        List of addresses to send blind carbon copy of message. Addresses listed
  102.         in this line will not be listed in header of message.
  103.  
  104. SUBJECT        Subject of message.
  105.  
  106. TIMEOUT        Timeout (in seconds) for socket operations. Default is 300.
  107.  
  108.  
  109. Name of configuration file can be passed to CGIMailer in two ways:
  110.  
  111.     - By setting SYS.CONFIGFILE on Your form. Your caling HTML code should look
  112.     as follows:
  113.  
  114.         <FORM method=GET action="http://your.server/cgi-bin/cgimail.exe?">
  115.         <input type=hidden name=SYS.CONFIGFILE value="configfile.cf">
  116.  
  117.             . . .
  118.  
  119.         </FORM>
  120.  
  121.     - Or by passing name of configuration file as command-line parameter:
  122.  
  123.         <FORM method=POST action="http://your.server/cgi-bin/cgimail.exe?configfile.cf">
  124.  
  125.             . . .
  126.  
  127.         </FORM>
  128.  
  129.  
  130.  
  131. NOTE:    path to configuration file must be relative to directory where cgimail.exe is placed,
  132.     or absolute path (with drive letter).
  133.     Also use SYS.CONFIGFILE variable when using GET method.
  134.  
  135. You can also call CGIMailer from <A HREF> tag with
  136.  
  137.     <a href="http://your.server/cgi-bin/cgimail.exe?configurationfile.cf&var1=val1&...">
  138. or
  139.     <a href="http://your.server/cgi-bin/cgimail.exe?&SYS.CONFIGFILE=configfile.cf&var1=val1...">
  140.  
  141. or
  142.     <a href="http://your.server/cgi-bin/cgimail.exe?SYS.CONFIGFILE=configfile.cf&var1=val1...">
  143.  
  144.  
  145.     4. Variables
  146.     ------------
  147.  
  148. CGIMailer will proccess configuration file, response template file and message template file
  149. (if any) to check for variables to be replaced. Variables should appear in following format:
  150.  
  151.     <%VARIABLE_NAME%>
  152.  
  153.  
  154. CGIMailer recognises four types of variables:
  155.  
  156. - Required variables    Required variable names must start with "REQ." (REQ.name for
  157.             example). When CGIMailer finds required variable in any of
  158.             following files: configuration file, response template file
  159.             or message template file, it will check if variable is passed
  160.             from form and if it contains any characters other than spaces.
  161.             If not so CGIMailer will generate an error. CGIMailer will also
  162.             check input from form for required variables.
  163.  
  164. - System variables    System variable names begin with "SYS." prefix. Folowing system
  165.             variables are present in CGIMailer:
  166.  
  167.             SYS.YEAR     - current year.
  168.             SYS.MONTH    - current month.
  169.             SYS.DAY        - day.
  170.             SYS.HOURES    - hour when CGIMailer is started.
  171.             SYS.MINUTES    - minit when CGIMailer is started.
  172.             SYS.SECONDS    - second when CGIMailer is started.
  173.             SYS.TEMPLATE    - name of response template file.
  174.             SYS.ERRTEMPLATE    - name of error template file.
  175.             SYS.MSGTEMPLATE    - name of message template.
  176.             SYS.MAILER    - name of mailer (defaults to: CGIMailer version 1.00)
  177.             SYS.INPUT    - preproccesed message wich is sent.
  178.             SYS.GATEWAY    - name of SMTP server.
  179.             SYS.HOST    - name of local host (where CGIMailer is executed).
  180.             SYS.PORT    - port number used to connect to SMTP service.
  181.             SYS.FROM    - E-mail addres of sender.
  182.             SYS.TO        - E-mail(s) of recipient(s).
  183.             SYS.CC        - Addresses listed in Cc: field.
  184.             SYS.BCC        - Bcc list of addresses.
  185.             SYS.SUBJECT    - Subject of message.
  186.             SYS.TIMEOUT    - Timeout for socket operations in seconds.
  187.  
  188. - Environment variables    Environment variable names begin with "ENV." prefix. CGIMailer will
  189.             replace every occurance of variable beginning with "ENV." prefix with
  190.             coresponding environment variable. For example occurance of ENV.TEMP
  191.             variable will be replaced with environment variable TEMP passed by OS
  192.             (contains name of default temporary directory on your system).
  193.  
  194. - Occurance of any other variable (not beginning with REQ., SYS. or ENV. prefix), will be simply
  195. replaced with its value.
  196.  
  197.  
  198.  
  199.  
  200.     5. Error template
  201.     -----------------
  202.  
  203. When an error occures (and if ERRTEMPLATE variable is set in configuration file) CGIMailer
  204. will use error template file to create an response to user. Error template file is
  205. an HTML document with directives of following form:
  206.  
  207.     <%SYS.errorNN%>
  208.  
  209. where NN is error code of error wich occures or one of keywords "default" or "end"
  210. For list of error codes generated by CGIMailer see errcodes.txt.
  211. When proccesing error template CGIMailer will create an HTML document from following
  212. parts of error template file:
  213.  
  214.     - beginning of document untill first <%SYS.errorNN%>, <%SYS.errordefault%>
  215.     <%SYS.errorend%> directive, or end of file if there is no any error directive.
  216.  
  217.     - section wich begins with <%SYS.errorNN%> directive (where NN is error code
  218.     of error generated by CGIMailer if such directive) or <%SYS.errordefault%>
  219.     directive if there is no an appropriate <%SYS.errorNN%> directive,
  220.     and ends with any other error directive or end of file if no error directives
  221.     are listed after this one.
  222.  
  223.     - section wich begins with <%SYS.errorend%> directive and ends with end of file.
  224.  
  225. For the complete listing of error codes see errcodes.txt
  226.  
  227.     6. Registration
  228.     ---------------
  229.  
  230. You have permission to use an unregistered copy of CGIMailer for
  231. period of 30 days for evaluation purposes only.
  232. If You continue to use CGIMailer after period of 30 days You have
  233. to register it.
  234. Also You have permission to distribute CGIMailer package under
  235. following conditions:
  236.  
  237.     - You have to distribute CGIMa111.zip package as it is without any changes. 
  238.     - You take no fee other than for distribution costs. 
  239.     - It must be clear that CGIMailer is shareware. 
  240.  
  241. CURRENTLY AN UNREGISTERED COPY OF CGIMAILER WILL ATTACH SHORT MESSAGE
  242. TO ALL CREATED PAGES.
  243.  
  244. To remove this messages You have to register. 
  245.  
  246. To register CGIMailer just follow these steps:
  247.  
  248.     - Obtain an registration key
  249.  
  250. If You are registered user of version 1.00 (or 1.10) just use Your version 1.00 (or 1.10)
  251. registration key (Upgrade is free for You).
  252.  
  253. If You are not an registered user of version 1.00 (1.10) You have to pay $15 as registration
  254. fee.
  255.  
  256. On-line registration is aviable via Register Now! service at:
  257.  
  258.     https://www.regnow.com/softsell/nph-softsell.cgi?item=1275-2
  259.  
  260. You can use Visa, Mastercard, American Express, or Discover card.
  261.  
  262. You can also send me money with mail to following address:
  263.  
  264.     Goran Boban
  265.     Zeleni trg 3, 10000 Zagreb
  266.     Croatia (Europe)
  267.  
  268. If You decide to send money with mail please send cache only. Also please contact me
  269. via e-mail before sending money.
  270.  
  271. Also be sure to send me following information
  272.  
  273. - Your first and last name (or company name)
  274. - E-mail address
  275. - Name of program you want to register (CGIMailer in this case)
  276.  
  277. BE SURE TO SEND AN E-MAIL ADDRESS SO I CAN SEND YOU A REGISTRATION KEY
  278.  
  279.  
  280.     - Register Your software using register.exe
  281. Register.exe utility is distributed within this package.
  282. By using register.exe You will disable messages which unregistered version of
  283. CGIMailer attaches to responses sent to user.
  284.  
  285. NOTE: For information on running register.exe see register.txt file.
  286.  
  287.  
  288.  
  289.     7. Bugs
  290.     -------
  291.  
  292.     PLEASE SEND BUG REPORTS to
  293.  
  294.         gboban@cursor.hr
  295.  
  296.     with:
  297.         CGIMail - bugs
  298.     in subject.
  299.  
  300.     Also feel free to contact me if you have any problems running or setting-up
  301.     CGIMailer or if you have any sugestions for future releases.
  302.  
  303.     IMPORTANT: When sending bug reports or questions please be sure to include
  304.     following information:
  305.  
  306.     - Program name    (CGIMailer)
  307.     - Version    (1.11)
  308.     - OS        (Win95/WinNT4.0)
  309.     - Web server name and version.
  310.     - What have You tryed to solve problem
  311.     - Any other information which You find relevant.
  312.  
  313.  
  314.  
  315.