home *** CD-ROM | disk | FTP | other *** search
/ M.u.C.S. Disc 2000 / MUCS2000.iso / online / amail / amail.txt < prev    next >
Text File  |  1999-02-23  |  15KB  |  329 lines
  1.                                Manual for aMail
  2.                                               .__.__   
  3.                         _____    _____ _____  |__|  |  
  4.                         \__  \  /     \\__  \ |  |  |  
  5.                          / __ \|  Y Y  \/ __ \|  |  |__
  6.                         (____  /__|_|  (____  /__|____/
  7.                              \/      \/     \/         
  8.    
  9.                             v1.05 from 21.02.1999
  10.  
  11.                             
  12. aMail is a GEM mail client for receiving, writing and sending mails via 
  13. InterNET. Its main features are:
  14.  
  15. o fully mouse controlled GEM program, smaller memory requirements 
  16.   than other "texts" programs ported from U*nix
  17. o works with MiNTNET - it doesn't need other TCP/IP sockets or STinG/STiK
  18. o has fully U*ix compatible mailboxes - you can fetch your mails from other 
  19.   system from work or school
  20. o supports UUENCODE and BASE64
  21. o supports MIME standard (you may save MIME attachments by drag&drop directly
  22.   into the desktop thanks to VA protocol; sent attachments have a set type
  23.   according to the file mime.types)
  24. o ASCII configuration file, so you can edit it freely in a text editor
  25. o you may define up to 25 mailboxes for sort your mail according to 
  26.   given rules
  27. o aMail hasn't own text editor - so you may use your favourite text editor,
  28.   but it must support OLGA protocol (QED, Everest).
  29. o supports AV, FONT, XFSL and UFSL
  30. o understands VA_START
  31. o parse URLs in messages (using URLserver - an utility from ATACK)
  32. o support Czech language and other iso-8859-XX charsets
  33. o and more features that you can evaluate yourself ;)
  34.  
  35. What do you need to run aMail?
  36. ------------------------------
  37. o MiNT
  38. o AES at least version 4.0 (ATARI AES4.x, N.AES, MagiC)
  39. o OLGA Manager
  40. o Text editor which supports OLGA protocol (QED, Everest)
  41. o 300 KB of free RAM
  42. o MiNTnet or STinG/STiK (for sending and receiving mail)
  43.  
  44. We recommend:
  45. -------------
  46. o MiNT 1.15.x (ftp://piwo.bl.pg.gda.pl/pub/atari/mint/Kernel/)
  47. o N.AES 1.2 (http://www.woller.de/)
  48. o QED 4.x (http://www.tu-harburg.de/~smcf1605/qed/main.html)
  49.  
  50. Some basic tips & hints: 
  51. ------------------------
  52. 1. If the program is placed on a minixfs partition and it doesn't run,
  53.    check the settings of executable flag (rwx--x--x)
  54. 2. If you want to use a mailbox from Unix, just suck it (e.g. with aFTP client)
  55.    and rename it to the $HOME/amail/inbox.
  56. 3. If you want to use a mailbox from Newsie, use the included script for converting.
  57. 4. Your text editor MUST support the OLGA protocol, because aMail sends the mail
  58.    after getting the message "Save File" from the OLGA Manager. TempDir must 
  59.    be written with the following format: drive:\dir\ and NOT /dir/ !
  60.    
  61. As a small bonus there is the script n2amail.sh for converting Newsie
  62. mailboxes into the Unix format includes to the package. Just run this script from 
  63. your shell and it will ask for necessary paths.
  64.  
  65. Start with a parameter or VA_START
  66. ----------------------------------
  67. You may start aMail with a parameter from a command line or you may drop 
  68. it by VA_START. The parameter must be of the URL form for mail sending
  69. (e.g. "mailto: atack@szt.cdrail.cz"). You may add your subject separated
  70. with a question mark
  71. (e.g. "mailto: atack@szt.cdrail.cz?subject=Testmail"). You can start aMail
  72. with .cfg file on the command line (or send a VA_START message).
  73.  
  74. URL parsing
  75. -----------
  76. When you click into the message text, the clicked word will be analysed and in
  77. case the word is in URL format (e.g. http://www.pwp.cz/atack) it will
  78. be sent by VA_START to the corresponding application (in this case for example
  79. CAB) with the assistance of URLSRV.
  80. URLSRV is freeware. It is included to the package. A newer version is available
  81. from the WWW page of Atack.
  82. Note: URLs are not highlighted yet!
  83.  
  84. User defined mailboxes
  85. ----------------------
  86. aMail can maintain up to 30 mailboxes. It has 5 internal mailboxes
  87. (inbox, sent-mail, outbox), so you can define up to 25 more. If you save
  88. aMail's config, aMail will create a remarked 3-line example in the config file.
  89.  
  90. -- start ------------- part of amail.cfg file -----------
  91. CustomBoxName = Atari CZ
  92. CustomBoxPath = g:\home\root\amail\atari
  93. DefaultTo = Atari@alpha.inf.upol.cz
  94. RuleSet = To: Atari@alpha.inf.upol.cz
  95. RuleSet = Reply-To: Atari@alpha.inf.upol.cz
  96. CustomBoxName = Work-outbox
  97. CustomBoxPath = g:\home\root\amail\work_out
  98. CustomBoxType = 1
  99. DefaultFrom = somebody@work.com
  100. -- end --------------- part of amail.cfg file -----------
  101.  
  102. Here is a closer explanation of the keywords:
  103. CustomBoxName - name of the mailbox. It will be displayed in the popup menu
  104.               - compulsory keyword
  105. CustomBoxPath - path and filename of a mailbox
  106.               - compulsory keyword
  107. CustomBoxType - you can set this mailbox as OUTBOX (CustomBoxType = 1)
  108. DefaultTo     - in case you have opened this mailbox and created a new message
  109.                 this will put the string as the address of the recipient automatically
  110.                 (e.g. To: address)
  111. DefaultFrom   - in case you have opened this mailbox and created a new message
  112.                 this will put the string as the address of the sender automatically
  113.                 (e.g. From: address)
  114. RuleSet       - after the '=' mark you can write a rule for sorting the
  115.                 mail. The string is searched in the message header 
  116.                 and according to the rule the message will be sorted to the defined
  117.                 mailbox
  118.     Functionality Notes:
  119.     "To: honza" - the message will be passed into this mailbox if anywhere
  120.         within their header on the line starting with "To:" and anywhere else 
  121.         the string "honza" will be found (e.g. "To: Friend honza")
  122.     "atari.com" - all messages which have the "atari.com" string 
  123.         within their header will be passed into this mailbox
  124.     It is also possible to create a so called blacklist (mail from
  125.     anywhere will be deleted automatically), one example follows:
  126. CustomBoxName = Black Hole
  127. CustomBoxPath = /dev/null
  128. RuleSet = From: scott
  129.  
  130. Object menu
  131. -----------
  132.  
  133. This menu may be called by pressing the right mouse button over the message 
  134. header (in the upper part of the window). Then you will work only 
  135. with the message under the mouse pointer (which will be selected). You may
  136. delete the message, move, or copy it to another mailbox (copy = move with 
  137. pressed the SHIFT key), create a new message, reply the message, 
  138. remove all flags or change the message (a new message is created, 
  139. which you can edit and the old one will be marked as deleted).
  140.  
  141. STOP button
  142. -----------
  143.  
  144. By this button you can stop the asock.ovl, which is fetching/sending 
  145. mail by the time. Therefore you should use this button only when it is really 
  146. needed! Usually when nothing happens for a long time (connection is lost) 
  147. or e.g. when you realise that you are sending a message to a wrong 
  148. person too late ;).
  149.  
  150. AV Protocol
  151. -----------
  152.  
  153. aMail supports and uses many GEM protocols for comfort improvement. 
  154. Except the minor ones like the FONT protocoll, UFSL, xFSL, Selectric, ... 
  155. the main one is obviously the AV protocoll. The main purpose is the 
  156. calling of external viewers for MIME attachments. In this case the 
  157. icon in the upper right corner of the window becomes clickable and you 
  158. can do one of the following things:
  159.  
  160.    1) click on the icon (single click)
  161.       - a fileselector appears and you can choose the destination path 
  162.         to save the attachment
  163.    2) doubleclick the icon
  164.       - the attachment is exported into the TMP directory and sent to the
  165.         AV server. For example if you receive amail.lzh as a file 
  166.         attachment and you have set the LZH-Shell for opening *.lzh files
  167.         the LZH-Shell will be started with the amail.lzh as argument
  168.    3) drag the icon and drop it on any disk icon, directory... on your 
  169.       desktop and the attachment file will be saved directly to where you 
  170.       have dropped it.
  171.  
  172.    If the file is encoded (and usually it really is) to one of the two 
  173.    possible codes then it will be automatically decoded while writing. The 
  174.    text is usually "quoted-printable" ('=3A' etc.) and binary files 
  175.    are usually in base64 code (thick column of funny characters).
  176.  
  177. Keyboard
  178. --------
  179.  
  180. Now we can describe the keys what can be used in aMail. Except the 
  181. hotkeys which you can easily find in the menu the keys are:
  182.  
  183. Arrows Up/Down     - scrolls the message contents to next/previous line
  184. Shift + Up/Down    - scrolls the message contents to next/previous page
  185. Clr/Home           - jump to the start of the message
  186. Shift + Clr/Home   - jump to the end of the message
  187. Arrows Left/Right  - jump to next/previous message
  188. SPACE              - jump to next page/message 
  189. Shift + Left/Right - jump to next/previous page of the messages
  190.  
  191. Address book
  192. ------------
  193.  
  194. The basic function and maintenance of the address-book is hopefully 
  195. clear to everybody, but what does the Group selection stand for? In general it 
  196. makes the work with the Cc: or Bcc: copies more simple. So if you are 
  197. sending messages to a constant (similar) group of recipients you 
  198. need not write to all of them twice. You may write them all (their e-mail 
  199. addresses) into a text file and then choose this file as a Group item 
  200. in the addressbook. There must be only ONE address per line. The first 
  201. address will be used as the primary address (to the To: field in the 
  202. message header).
  203.  
  204. Sounds
  205. ------
  206.  
  207. If the audio device driver (audiodev.xdd) is installed, aMail can play 
  208. samples as a note about some events that may occur.
  209.  
  210. All samples must be raw sound data, mono, 8bit signed, 12500Hz.
  211. If you don't want sounds, just 
  212. a) uninstall the audio device or
  213. b) delete or rename all samples (sound/new.raw, sound/error.raw) or the
  214.    sound/ directory.
  215.  
  216. Reply-to
  217. --------
  218.  
  219. aMail knows how to handle the following variants of a message header.
  220. Let's describe them:
  221.  
  222.    o The header contains only From:
  223.      - without any other question this will be replied to the address
  224.        from the From: field
  225.  
  226.    o The header contains only From: and To:, which doesn't correspond 
  227.      to your e-mail address
  228.      - the [From: | To: | All] dialog appears, where the [All] choice
  229.        replies to the addresses from the From: and To: fields.
  230.  
  231.    o The header contains only From: and Reply-to:
  232.      - the [From: | Reply-to | All] dialog appears, where the [All]
  233.        choice replies to the addresses from the From: and Reply-to:
  234.        fields.
  235.  
  236.    o The header contains only From: and Cc:
  237.      - the [From: | Cc | All] dialog appears, where the [All]
  238.        choice replies to the addresses from the From: and Cc: fields.
  239.  
  240.    o The header contains only From:, Reply-to and Cc:
  241.      - the [From: | Reply-to | All] dialog appears, where the [All]
  242.        choice replies to the addresses from the From:, Reply-to: and
  243.        Cc: fields.
  244.  
  245.    If in the last three cases the address within the To: field doesn't
  246.    correspond to your e-mail address (as in the 2nd case) then if you
  247.    choose [All] then this address will be appended as well.
  248.  
  249.    In any other case the normal dialog for the header filling appears 
  250.    (To:, Subject:, Cc:, attachment) and you may change anything you like.
  251.     
  252. Quote string
  253. ------------
  254.  
  255. You may define an own string, max. 10 chars (why longer, then it will 
  256. be long over the half of a line ;) and more, you can use special formatting 
  257. chars. Currently aMail distinguishes only %i as the name initials, e.g. if 
  258. you reply a mail "From: Jan Evangelista Purkyne" and your quote 
  259. string is "%i > ", all lines will begin with a "JEP > " string. Yep! ;)
  260.  
  261. MIME attachments
  262. ----------------
  263.  
  264. The type of an attachment will be automatically set during message sending
  265. according to its file extension and the file mime.types, which will be searched
  266. within the following directories (in this order):
  267. 1) /usr/local/share/mime.types
  268. 2) ~/.mime.types
  269. 3) ./mime.types
  270.  
  271. The file format is plain text, standard and simple ;)
  272. --- mime.types ----
  273. application/postscript  ps eps ai
  274. image/gif               gif
  275. image/jpeg              jpg jpeg jpe
  276. text/html               htm html
  277. text/plain              txt c h cc
  278. --- mime.types ----
  279.  
  280. If the type is text/* quoted-printable code will be used
  281. as required for text files (containing ASCII character codes higher than 127
  282. or if the lines are longer than 72 characters) or the base64 code if it
  283. isn't a text file.
  284.  
  285. Limitations
  286. -----------
  287.  
  288. The number of messages in the mailbox is limited, but the number is given
  289. in the config file (a text file) where you can edit them simply.
  290. There are two numbers, one for the amount of memory to be reserved for 
  291. message headers (default is 200kB which is sufficient enough ;) and the 
  292. other one is the maximum number of messages in the mailbox (default is 
  293. 1000, maximum is 32768). Both numbers correspond and it would be 
  294. possible to compute one according to the other one, but this way the 
  295. programm is more configurable and the nations with short names may set 
  296. different values, which we can't know, as they want ;)
  297. If any of these limits are exceeded while the mailbox opening it 
  298. will be interrupted and the mailbox is further locked as "read only" because 
  299. the messages which wouldn't have fit in would be lost after mailbox closing. 
  300. Therefore, the flags wouldn't be saved (read, new), the messages marked 
  301. for deletion (even for move to other mailbox) wouldn't be deleted and 
  302. also the mailbox couldn't be compressed.
  303. Another limit we are hoping to become history soon is the wrong handling 
  304. of messages with more than one address within the To: field.
  305. Next limitation: messages forwarding works without forwarding of MIME attachments. 
  306. The last known limitation to reach is to handle nested MIME attachments 
  307. (other MIME attachment within other ones). No one told us about it and no 
  308. one was ready for this and unfortunately such messages are appearing
  309. more and more frequently.
  310.  
  311. Thanks
  312. ------
  313.  
  314. We would like to thank all betatesters who shared their expensive time in 
  315. developing and helping with their suggestions and their advice. We want also 
  316. thank to Christian Felsch for his QED - a great text editor. All aMail sources 
  317. have been written with QED. And of course thanks to U2, Pink Floyd and 
  318. to Stones for the best music for programming ;)
  319.  
  320. If aMail doesn't work just write down what it does or not, when and 
  321. where and the versions of your system components (OS version, MiNTnet 
  322. version, AES, free RAM at a start of aMail, environment variables 
  323. setting, ...)
  324.  
  325.                                      Yours ATACK (InterNET division :)
  326.    
  327.                                            e-mail: atack@szt.cdrail.cz
  328.                                            http://www.pwp.cz/atack/
  329.