home *** CD-ROM | disk | FTP | other *** search
/ The Unsorted BBS Collection / thegreatunsorted.tar / thegreatunsorted / programming / misc_programming / messages.txt < prev    next >
Text File  |  1992-01-01  |  5KB  |  93 lines
  1.  
  2.  
  3.               Format of the exported messages in Messages.Dat
  4.  
  5.  
  6.          This file contains records with a length of 128 bytes.  There
  7.          are 3 types of these records: (1) Packet Header, (2) Message
  8.          Header, and (3) Message Text.  All unused fields in the
  9.          records are normally filled with spaces, although you will
  10.          sometimes find the final Message text record will be filled
  11.          with nulls (#0) after the last text.
  12.  
  13.  
  14.                               Packet Header
  15.  
  16.          Packet Header - is always the first record in the file and
  17.          only occurs once.  It contains only normal ascii text
  18.          (limitted to at most 128 characters) and should always
  19.          start with "Produced by ".  The remaining text normally
  20.          includes a product name and copyright message.
  21.  
  22.  
  23.                               Message Header
  24.  
  25.          A message header immediately preceeds zero or more message
  26.          text records.  Each Message header has the following
  27.          format:
  28.  
  29.          Start
  30.           Pos  Length              Description
  31.         ------ ------ -----------------------------------------
  32.            1      1   Message status flag (see below)
  33.            2      7   Message number (ascii left justified)
  34.            9      8   Date (MM-DD-YY)
  35.           17      5   Time (HH:MM)
  36.           22     25   To (left justified space filled - uppercase)
  37.                       (Be sure to check the to field to spot
  38.                       configuration type messages)
  39.           47     25   From (left justified space filled - uppercase)
  40.           72     25   Subject (left justified space filled - uppercase)
  41.                       (a subject starting "NE:" should not be
  42.                       echoed into a network)
  43.           97     12   Password (not really used leave blank)
  44.          109      8   Message reference number (ascii left justified)
  45.          117      6   Number of blocks (ascii left justified - number
  46.                       of 128 byte blocks including 1 for the message
  47.                       header)
  48.          123      1   Message active (ß or #225 = Active,
  49.                       Γ or #226 = Inactive)
  50.          124      2   Conference number (Binary Word) (Lo in 124, Hi
  51.                       in 125).  Note that some older programs only
  52.                       supported conferences 0 thru 255 and left byte
  53.                       125 as a "blank" unused field.  I recommend
  54.                       checking the word value and if it is over 8191
  55.                       to only use the lower (0 thru 255) part of it.
  56.                       I've also seen notes that this field is really
  57.                       a 4 byte LongInt field, although with the above
  58.                       limitation (and 8000 conference seeming sufficient
  59.                       for a while), I documented it this way.
  60.  
  61.          128      1   Indicates whether the message has a Network
  62.                       tagline or not.  A value of "*" indicates that
  63.                       a network tagline is present, a value of " "
  64.                       indicates there isn't.  Messages sent to readers
  65.                       (non-net-status) generally leave this as always
  66.                       blank since only net utils need this info.
  67.  
  68.          Message Status Flag has the following possibilities:
  69.  
  70.          '`'  Comment to sysop, read      '~'  Comment to sysop, unread
  71.          '-'  Public, read                ' '  Public, unread
  72.          '*'  Private, read               '+'  Private, unread
  73.          '^'  Password protected, read    '%'  Password protected, unread
  74.          '#'  Group password, read        '!'  Group password, unread
  75.          '$'  Group password to all
  76.  
  77.  
  78.  
  79.                              Message Text Records
  80.  
  81.          The message text records immediately follow the the message
  82.          header.  They contain straight ascii text (lines are
  83.          normally limitted to 72 chars/line although you may see
  84.          longer lines).  Each line is followed by a "π" or #227
  85.          character to mark the end of the line (in place of the normal
  86.          CR/LF that would exist in a straight text file).  The text
  87.          continues consecutavly and text lines do continue across
  88.          block boundaries.  Some systems or readers may have problems
  89.          with messages longer than 99 lines or 199 lines, although more
  90.          recently this no longer seems to be a limit.  The last block
  91.          should be padded with blanks to fill the block, although on
  92.          input you may find it padded with nulls (#0).
  93.