home *** CD-ROM | disk | FTP | other *** search
/ ftp.barnyard.co.uk / 2015.02.ftp.barnyard.co.uk.tar / ftp.barnyard.co.uk / cpm / walnut-creek-CDROM / ENTERPRS / C128 / TEXT / QWKSPECS.TXT < prev    next >
Text File  |  2000-06-30  |  14KB  |  346 lines
  1.                      .----------------------------.
  2.                      : The QWK Mail Packet Format :
  3.                      `----------------------------'
  4.  
  5. BBS ID
  6. ------
  7.  
  8.     The BBS ID is a 1-8 characters string that identifies a BBS' mail
  9.     packet.  The filename of the mail packet is often the BBS ID.
  10.     However, this is not always the case, so do not rely on that to
  11.     determine the BBS ID.  Instead, it is included on the fifth line of
  12.     the CONTROL.DAT file (see below.)
  13.  
  14. Compression
  15. -----------
  16.  
  17.     Most mail packets are compressed when create by the mail door.  The
  18.     most common archiver is PKZIP, but others such as LHA is being used.
  19.     However, many current off-line reader programs do allow the user to
  20.     unarchive a mail packet before entering the reader program, so the
  21.     reader will not unarchive it again.  Upon exit, the reader will not
  22.     call the archiver to save it.  It is up to the user to archive the
  23.     replies.
  24.  
  25. MESSAGES.DAT
  26. ------------
  27.  
  28.     The QWK file format is based on the PCBoard 12.0 message base
  29.     formats from Clark Development Corporation.
  30.  
  31.     All of the messages in a mail packet are contained in a single file
  32.     named MESSAGES.DAT.  The file's logical record length is 128 bytes.
  33.     The first record of MESSAGES.DAT always contains a copyright notice
  34.     saying "Produced by Qmail...Copyright (c) 1987 by Sparkware.  All
  35.     Rights Reserved".  Messages start in record 2 and use this format:
  36.  
  37.     Offset  Length  Description
  38.     ------  ------  ----------------------------------------------------
  39.       1       1     Message status flag
  40.                     ' ' = public, unread
  41.                     '-' = public, read
  42.                     '+' = private, unread
  43.                     '*' = private, read
  44.                     '~' = comment to Sysop, unread
  45.                     '`' = comment to Sysop, read
  46.                     '%' = password protected, unread (protect by sender)
  47.                     '^' = password protected, read (protect by sender)
  48.                     '!' = password protected, unread (protect by group
  49.                           password)
  50.                     '#' = password protected, read (protect by group
  51.                           password)
  52.                     '$' = password protected, addressed to all (protect
  53.                           by group password)
  54.       2       7     Message number (in ASCII)
  55.       9       8     Date (mm-dd-yy)
  56.      17       5     Time (24 hour hh:mm)
  57.      22      25     To (uppercase)
  58.      47      25     From (uppercase)
  59.      72      25     Subject of message
  60.      97      12     Password (usually space filled)
  61.     109       8     Reference message number (in ASCII)
  62.     117       6     Number of 128 byte blocks in message (counting the
  63.                     header, in ASCII)
  64.     123       1     Is message killed?  ASCII 225 is active, 226 is
  65.                     killed
  66.     124       2     Conference number (as long integer), 124 is the
  67.                     least significant, 125 is most
  68.     125       3     Not used (usually filled with space)
  69.  
  70.     The text of message continues in the next record.  You can find out
  71.     how many blocks make up one message by looking at the value of
  72.     "Number of 128 byte blocks".  Message text is delimited by a ASCII
  73.     227 (pi character) symbol between lines.
  74.  
  75. xxx.NDX
  76. -------
  77.  
  78.     The xxx.NDX files contain record numbers that point into the
  79.     MESSAGES.DAT file for actual messages.  Each conference that
  80.     contains messages has its own "xxx.NDX" file.  The "xxx" is the
  81.     conference number for the index file.
  82.  
  83.     Each NDX file uses a five bytes logical record length and is
  84.     formatted to:
  85.  
  86.     Offset  Length  Description
  87.     ------  ------  ----------------------------------------------------
  88.       1       4     Record number pointing to corresponding message in
  89.                     MESSAGES.DAT.  This number is in the Microsoft MKS$
  90.                     BASIC format.
  91.       5       1     Conference number of the message.  This byte should
  92.                     not be used because it duplicates both the filename
  93.                     of the index file and the conference # in the
  94.                     header.  It is also one byte long, which cannot
  95.                     handle conferences over 255.
  96.  
  97.     The formula for converting X, a long integer in MKS$ format, to
  98.     MKSToNum, a binary integer, is:
  99.  
  100.     MKSToNum := ((X AND NOT $ff000000) OR $00800000)
  101.                 SHR (24 - ((x SHR 24) AND $7f));
  102.  
  103.     Or in Turbo Pascal:
  104.  
  105.     type
  106.         bsingle = array [0..3] of byte;
  107.  
  108.     { converts TP real to Microsoft 4 bytes single }
  109.  
  110.     procedure real_to_msb (preal : real; var b : bsingle);
  111.     var
  112.         r : array [0 .. 5] of byte absolute preal;
  113.     begin
  114.         b [3] := r [0];
  115.         move (r [3], b [0], 3);
  116.     end; { procedure real_to_msb }
  117.  
  118.     { converts Microsoft 4 bytes single to TP real }
  119.  
  120.     function msb_to_real(b : bsingle) : real;
  121.     var
  122.         preal : real;
  123.         r : array [0..5] of byte absolute preal;
  124.     begin
  125.         r [0] := b [3];
  126.         r [1] := 0;
  127.         r [2] := 0;
  128.         move (b [0], r [3], 3);
  129.         msb_to_real := preal;
  130.     end; { procedure msb_to_real }
  131.  
  132.     There is a special index file named PERSONAL.NDX.  This file
  133.     contains pointers to messages which are addressed to the user, i.e.
  134.     personal messages.  Some mail door and utility programs also allow
  135.     the selection of other messages to be flagged as personal messages
  136.     as well.
  137.  
  138. CONTROL.DAT
  139. -----------
  140.  
  141.     The CONTROL.DAT file is a simple ASCII file.
  142.  
  143.     Aardvark BBS                    BBS long name
  144.     New York, NY                    BBS city and state
  145.     212-496-8324                    BBS number
  146.     David Greenberger, Sysop        BBS Sysop name
  147.     20052,AARDVARK                  Mail door registeration #, BBS ID
  148.     10-19-1990,00:36:13             Packet creation time
  149.     PATRICK LEE                     User name
  150.                                     Name of menu for Qmail, if exists
  151.     0                               ?
  152.     0                               ?
  153.     121                             Total number of conf. minus 1
  154.     0                               1st conference number
  155.     Main Board                      1st conference name
  156.     1                               2nd conference number
  157.     General                         2nd conference name
  158.     3                               etc. onward until it hits max. conf.
  159.     123                             Last conference number
  160.     Amiga_I                         Last conference name
  161.     HELLO                           Welcome screen file
  162.     NEWS                            BBS news file
  163.     SCRIPT0                         Log off screen
  164.  
  165.     [ Some mail doors do not send the information below here. ]
  166.  
  167.     0                               ?
  168.     25                              ?
  169.     PATRICK LEE                     User name in uppercase
  170.     Patrick                         User first name
  171.     ELMHURST, NEW YORK              User city, state
  172.      718 639-6696                   User data phone
  173.      718 639-6696                   User home phone
  174.     108                             Security level
  175.     00-00-00                        Expiration date
  176.     10-17-90                        Last log on date
  177.     23:22                           Last log on time
  178.     209                             Log on count
  179.     0                               ?
  180.     0                               Total KB downloaded
  181.     34                              Download count
  182.     0                               Total KB uploaded
  183.     110                             Upload count
  184.     120                             Minutes per day
  185.     52                              Minutes remaining today
  186.     3                               Minutes used this call
  187.     32767                           Max. download KB per day
  188.     32767                           Remaining KB today
  189.     0                               KB downloaded today
  190.     00:36                           Current time on BBS
  191.     10-19-90                        Current date on BBS
  192.     Aardvark BBS                    BBS name
  193.     5059                            ?
  194.  
  195. Replies
  196. -------
  197.  
  198.     Replies use a similar format, except the message number becomes the
  199.     conference number.  Also, the first record (up to 8 characters
  200.     starting on the first byte) in the reply file contains the BBS's ID.
  201.     This ID must much the one on the BBS in order for the mail door to
  202.     accept the replies.
  203.  
  204. Pointer files
  205. -------------
  206.  
  207.     *.PTR or *.PNT
  208.  
  209.     Don't bother with the pointer files, as the off-line reader has no
  210.     real use for it.  The mail doors send it so that the user will have
  211.     a copy of it, in case something on the BBS screws up.
  212.  
  213. Other files
  214. -----------
  215.  
  216.     Bulletins are sometimes send in the mail packet as well, this is
  217.     usually configurable by the user.  The files for the bulletins are
  218.     named:
  219.  
  220.         BLT-x.y
  221.  
  222.     where 'x' is the conference number, and 'y' is the bulletin number.
  223.  
  224.     New files are also configurable and can be sent by the mail door.
  225.     The file name for that is NEWFILES.DAT
  226. .
  227. Off-line mail door configuration
  228. --------------------------------
  229.  
  230.     For Qmail 4.0a:
  231.  
  232.         Send a private message addressed to "QMAIL" with a subject of
  233.         "CONFIG" (without quotes).  Then, enter any of the commands
  234.         listed below inside the text of your message.  Remember to use
  235.         one command per line.
  236.  
  237.         ADD <confnum>           Add a conference into the Qmail Door
  238.                                 4.00 scanning list. "YOURS" can also be
  239.                                 added to the command if the user wishes
  240.                                 to receive messages only addressed them.
  241.                                 Example: ADD 1 YOURS
  242.         DROP <confnum>          Drop a conference from the Qmail Door
  243.                                 4.00 scanning list.
  244.         RESET <confnum> <value> Resets a conference to a particular
  245.                                 value. The user can use "HIGH-xxx" to
  246.                                 set the conference to the highest
  247.                                 message in the base.
  248.         CITY <value>            Changes the "city" field in the User's
  249.                                 PCBoard entry.
  250.         PASSWORD <value>        Changes the user's login password.
  251.         BPHONE <value>          Business/data phone number
  252.         HPHONE <value>          Home/voice phone number
  253.         PCBEXPERT <on|off>      Turns the PCBoard EXPERT mode ON or OFF.
  254.         PCBPROT <value>         PCBoard file transfer protocol (A-Z).
  255.         PAGELEN <value>         Page length inside PCBoard.
  256.         PCBCOMMENT <value>      User maintained comment.
  257.         AUTOSTART <value>       Qmail Door autostart command.
  258.         PROTOCOL <value>        Qmail Door file transfer protocol (A-Z).
  259.         EXPERT <on|off>         Turns the Qmail Door EXPERT mode ON or
  260.                                 OFF.
  261.         MAXSIZE <value>         Maximum size of the user's .QWK packet
  262.                                 (in bytes)
  263.         MAXNUMBER <value>       Maximum number of messages per
  264.                                 conference.
  265.  
  266.     For MarkMail:
  267.  
  268.         Send a private message addressed to "MARKMAIL" with the subject
  269.         line of:
  270.  
  271.         "ADD" in the conference you want to add
  272.         "DROP" in the conference you want to drop
  273.         "YOURS" in the conference you want only your mail sent
  274.         "FILES ON" or "FILES OFF" in any conference to tell MarkMail
  275.             whether to scan for new files or not.
  276.         "BLTS ON" or "BLTS OFF" to turn on and off, respectively, of
  277.             receiving bulletins.
  278.         "OWN ON" or "OWN OFF" to turn on and off, respectively, of
  279.             receiving messages you sent
  280.         "DELUXE ON" or "DELUXE OFF" to turn on and off, respectively, of
  281.             receiving DeLuxe menu
  282.         "LIMIT size" to set the maximum size of MESSAGES.DAT file can
  283.             be, it cannot exceed what the Sysop has set up
  284.  
  285.         After "ADD" or "YOURS", you can also put in the message number
  286.         you want to reset the conference to; or you can enter a relative
  287.         number, i.e. -50, to reset the message pointer to the highest in
  288.         the conference minus 50.
  289.  
  290. Non-echoed messages
  291. -------------------
  292.  
  293.     In order to send a non-echoed message (not send out to other BBSes),
  294.     a user can enter "NE:" in front of the subject line.  The MarkMail
  295.     door will strip this "NE:" and turn off the echo flag.
  296.  
  297. Taglines
  298. --------
  299.  
  300.     The most common format for a reader tag-line is:
  301.  
  302.     ---
  303.      ~ My reader v1.00 ~ The rest of the tag-line.
  304.  
  305.     The three dashes is called a tear-line.  The tag-line is appended to
  306.     the end of the message and is usually one line only.
  307.  
  308. DOOR.ID
  309. -------
  310.  
  311.     DOOR = <doorname>
  312.  
  313.         This is the name of the door that created the QWK packet, i.e.
  314.         <doorname> = Tomcat.
  315.  
  316.     VERSION = <doorversion>
  317.  
  318.         This is the version number of the door that created the packet,
  319.         i.e. <doorversion> = 2.9.
  320.  
  321.     SYSTEM = <systemtype>
  322.  
  323.         This is the underlying BBS system type and version, i.e.
  324.         <systemtype> = Wildcat 2.55.
  325.  
  326.     CONTROLNAME = <controlname>
  327.  
  328.         This is the name to which the reader should send control
  329.         messages, eg. <controlname> = TOMCAT.
  330.  
  331.     CONTROLTYPE = <controltype>
  332.  
  333.         This can be one of ADD, DROP, or REQUEST (or others.)  ADD and
  334.         DROP are pretty obvious (they work as in MarkMail), and REQUEST
  335.         is for use with BBS systems that support file attachments.  Try
  336.         out SLMR with CONTROLTYPE = REQUEST and use the Q function.
  337.  
  338.     RECEIPT
  339.  
  340.         This flag indicates that the door/BBS is capable of return
  341.         receipts when a message is received.  If the first three letters
  342.         of the subject are RRR, then the door should strip the RRR and
  343.         set the 'return-receipt-requested' flag on the corresponding
  344.         message.
  345.  
  346.