home *** CD-ROM | disk | FTP | other *** search
/ Meeting Pearls 3 / Meeting_Pearls_III.iso / Pearls / tcp / Networking / TCP / Mail / mail / mail.doc < prev    next >
Encoding:
Text File  |  1994-03-06  |  4.5 KB  |  133 lines
  1. INTRODUCTION
  2.  
  3. This program is © Copyright 1993 Stephen Norris.
  4.  
  5. It may be freely distributed, but not sold for profit or included
  6. in any product without permission from the author.
  7.  
  8. If you find it useful, find a bug or want an enhancement, please
  9. let me know at:
  10.  
  11. srn@cs.su.oz.au
  12.  
  13. REQUIREMENTS
  14.  
  15.     A network link (obviously).
  16.     AmiTCP V2.1 or later.
  17.  
  18. RATIONAL (Or, What is it for?)
  19.  
  20.     My intention when writing this program, was to produce a piece of
  21. software for sending mail _only_.  The program is not for recieving mail,
  22. for that use AmiPOP.
  23.  
  24.     It does, on the other hand, send mail to many addresses, is RFC822
  25. compliant (this is the RFC regarding mail headers) and it is free.
  26.  
  27. INSTALLATION
  28.  
  29.     You need to set the following variables with setenv:
  30.  
  31.     SMTPHOST - The site that you use to send SMTP mail (is running
  32.              an SMTP demon).
  33.              This name can be either an IP address or (better) a name.
  34.     USERNAME - Your name.  Used in the default reply address.
  35.     HOSTNAME - from the AmiTCP setup.
  36.  
  37.     The following variables aren't _needed_ but will make things much nicer:
  38.  
  39.     REALNAME - Your real name, as it should appear in your mail.
  40.     EDITOR - You should set this to the name of an editor you want
  41.          to edit mail with.
  42.     SIGFILE - is the name of a file which is always appended to your mail, such
  43.           as a signature.
  44.  
  45. USAGE
  46.  
  47.     By default, when you run mail, it will prompt for a subject, then start
  48. an editor.  Once in the editor you can type your mail (be careful not to change
  49. the existing Subject: header - you can change what is after the colon, but not
  50. the actual word).  The body of the mail should start at least one blank line down
  51. the page.
  52.  
  53.     Any extra headers you want to include should be added _above_ the Subject:
  54. header.
  55.  
  56.     Template:
  57.  
  58. RCPT=RECIPIENT/M/A,REPLYTO,SMTPHOST/K,NOSIG/S,VERBOSE/S,NOSUBJ/S,NOHEAD/S,NOED
  59.  
  60.     RECIPIENT is a list of people to send mail to.
  61.     REPLYTO is the address which should appear on your from: line (where
  62.     replies will be sent).  It over-rides that generated as a default (see
  63.     above).
  64.     SMTPHOST is a host to use to send the mail from (over-rides the SMTPHOST
  65.     variable).
  66.     VERBOSE turns on (slightly) more verbose debugging output.
  67.  
  68. The next options are intended to make it easy to use the program as a sendmail
  69. replacement.
  70.  
  71.     NOSUBJ turns off generation of the subject line.
  72.     NOHEAD turns off generation of all headers.
  73.     NOED turns off the use of an editor, and reverts to line-by-line
  74.     entering of mail.  The editor used is determined by the EDITOR variable.
  75.     NOSIG turns off the inclusion of the signature file.
  76.  
  77. COMPILING
  78.  
  79.     The program will compile using DICE, after applying the available
  80. patches to the DICE libraries, which integrate the sockets stuff into the
  81. file descriptor code.
  82.  
  83. EXAMPLE
  84.  
  85.     mail fred@company.com REPLYTO=srn@cs.su.oz.au SMTPHOST=joyce.cs.su.oz.au VERBOSE
  86.  
  87.     Sends mail to fred at company, with the from: line set to srn@cs.su.oz.au,
  88. using the SMTP server running on joyce.cs.su.oz.au and including the file s:.sig.
  89. It will run in verbose mode, printing out longer error messages, and telling you
  90. as it sends each piece of mail.
  91.  
  92. BUGS
  93.  
  94.     Not a bug, but a potential problem is the way mail handles external editors.
  95. If the editor runs asynchronously (i.e. the shell prompt returns before you quit
  96. from it when you run it) then it _will not_ work with mail.  Use an editor
  97. that behaves like MicroEmacs, ed, vi or similar.  I'm working on a fix for this.
  98.  
  99. HISTORY
  100.  
  101.     (B is a bug fix, + is added functionality)
  102.  
  103.     1.8    B Hacked around a problem with extended replies that broke mail
  104.         on some hosts.
  105.  
  106.     1.7    B Eliminated all references to SMTPSERVER 
  107.         + Removed SIGFILE option, and made it a shell variable to be
  108.         consistent with the other options.
  109.         + Added a NOSIG option. (thanks go to Jim Dutton for pointing this
  110.         inconsistency out and suggesting these improvements).
  111.         + Added .sig file before editing with an external editor.
  112.         + Added Reply-to: line, and changed From: line to the actual
  113.         from address.
  114.         + Added MessageId: line.
  115.  
  116.     1.6    Optimised sending code (this is a bit embarrasing, compare 1.5
  117.         with this one if you want more details).
  118.         Tidied code up a little.
  119.         Added support for editors when sending mail.
  120.         Added automatic inclusion of signature files.
  121.  
  122.     1.5    Fixed up SMTP transaction (added HELO and changed order of
  123.         MAIL FROM and RCPT TO commands).
  124.  
  125.     1.4    Corrected documentation error.
  126.         Added To: lines that list all the destinations of the mail.
  127.  
  128.     1.3    First release of fixed up version.
  129.  
  130.     1.2    Horribly buggy release, made while half asleep.
  131.  
  132.     1.1    First release.  Minimally functional.
  133.