QWK Format

QWK packets and their closely related Reply (REP) packets are single-file archives (usually in PKZIP format) containing one or more data files. QWK packets are filenames with a .QWK suffix/extension, while Reply packet filenames have a .REP suffix.

A QWK packet filename is normally of the form: ID.QWK (or ID.qwk), where ID is the unique QWK identifier (up to 8 valid MS-DOS filename characters, starting with an alphabetic character) of the system from where the messages were downloaded (received).

Similarly, a QWK Reply (REP) Packet filename is normally ID.REP (or ID.rep) where ID is the QWK-ID of the destination system for which the REP packet is to be sent (uploaded).

When multiple packet filenames with the same ID are stored in the same directory, it is customary to replace the last character in the filename suffix with an incrementing decimal digit, beginning with 0. e.g.

VERT.qwk
VERT.qw0
VERT.qw1
VERT.qw2

If there are more than 11 QWK packet filenames, then it is customary to replace the last 2 characters with incrementing decimal digits, beginning with 10, e.g.

VERT.REP
VERT.RE0
...
VERT.RE9
VERT.R10
VERT.R11
VERT.R12

QWK packets are typically created-on and downloaded-from a large message archive (e.g. a collection of message bases) on a remotely-accessible system (e.g. BBS). The messages contained in the packet may include both private messages (e.g. e-mail) and public messages (e.g. posts on topical conferences). While the private messages are typically addressed *only* to the user that downloaded the QWK packet, the public messages may be addressed to anyone (or often, “All”).

The files that may be contained within a QWK packet (archive) include:

The first 3 files (MESSAGES.DAT, HEADERS.DAT, and VOTING.DAT) are the most important when it comes to Synchronet QWK networking.

The MESSAGES.DAT file (and ID.MSG file) is written in multiples of 128-byte blocks.

The first 128-byte block in the file contains a space-padded US-ASCII string identifying the software that generated the packet.

fprintf(qwk,"%-128.128s","Produced by " VERSION_NOTICE "  " COPYRIGHT_NOTICE);

Conversely, the first 128-byte block of an ID.MSG file from a .REP packet contains the QWK-ID of the system for which the packet was created and is intended to be uploaded-to.

• All subsequent 128-byte blocks in the file are either header blocks or body blocks.
• Each header block identifies a unique message in the packet.
• Header blocks are fixed length (128 bytes).
• Each message has only one corresponding header block.
• A normal message will have at least one body block (at minimum).
• Vote messages (ballots, polls, up/down-votes) will not have a corresponding body block (see VOTING.DAT file).
• A header block includes an indication of the total number of blocks before the next header block (minimum: 1).

ASCII string fields are space-filled and generally left-justified. Unused bytes are generally filled with a space (ASCII 32) character. Multi-byte integer are stored in little-endian byte order (LSB first).

The Message Status character has the following known definitions:

As you may have noticed, the QWK message header block contains some narrow limitations and bizarre inconsistencies. For example:

• Most fields are US-ASCII, while some are binary integers
• Names (to and from) are limited to 25 characters while standard FidoNet messages support up to to 35-character names
• Subjects are limited to 25 characters while standard FidoNet messages support up to 71-character subjects
• The “password” field doesn't seem to have ever been used by anything, but easily could have been used to extend subjects to 37 characters
• Message dates are limited to 2-digit years
• Message times are in hours and minutes only (no seconds)
• No timezone information
• A maximum conference number of 9,999,999 is allowed in the field at offset 1 of a .MSG file, while the conference number at offset 123 is limited to just 65,535.
• The message number at offset 1 of a MESSAGES.DAT file is limited to 9,999,999 while the In-reply-to message number (at off 108) can hold a number up to 99,999,999.

All of this craziness is addressed with the Synchronet-defined HEADERS.DAT file.

The text of a message is contained in one or more body blocks which follow the header block.

If the message does not fit in an exact-multiple of 128-byte blocks, the last body block of a message is padded with spaces or NULLs.

For unclear reasons, new-lines sequences are normally represented by the character 0xE3 (227). In UTF-8 encoded messages, Synchronet uses ASCII 10 (LF) to represent new-lines in QWK message bodies.

The first lines of a message's text may contain metadata for the message (so-called “kludge lines”). Any blank lines following a set of kludge lines should be ignored.

The Extended QWK (QWKE) standard defines 3 initial lines which, if present, replace the equivalent values from the header block. The QWKE standard says that the “kludge lines” may be terminated by either the QWK newline character (0xE3) or an ASCII carriage-return (13) character. The QWK newline character (or ASCII LF for UTF-8 encoded message) is recommended.

There are some additional Synchronet-defined kludge lines that may exist at the beginning of a message body:

All of this craziness is addressed with the Synchronet-defined HEADERS.DAT file.

As can be seen in the definition of the QWK MESSAGES.DAT header block definition and the subsequently defined “kludge lines” to address its problems, the QWK format was not really designed to be very extensible or accommodating of newer or larger header fields. However, because the QWK packet is an archive of multiple files, adding more standard files is relatively trivial, hence the “new” Synchronet-defined HEADERS.DAT file¹⁾.

The HEADERS.DAT is a text file (CRLF or LF-terminated lines is fine), in .ini file format. Through the use of the HEADERS.DAT file, long header field values and additional header fields may be defined and used without resulting to “kludge lines”.

Each section in the HEADERS.DAT file correlates with a message in the corresponding MESSAGES.DAT (or ID.MSG) file. The section name is the byte-offset (in hexadecimal) into the MESSAGES.DAT file of the corresponding message's header block.

Key/value pairs may be specified using key = value or key: value syntax, but the latter is preferred to indicate to the parser that trailing white-space is significant and should be retained. Leading white-space in header field values is never significant and always ignored/stripped.

Header field values may each be up to 1024 US-ASCII characters length. When “high ASCII” characters are included in any header field values, the IBM CP437 character set is assumed unless there is an indication that the header fields are in UTF-8 format, in which case all header fields, for a particular message, with “high ASCII” characters must be in UTF-8 format. The indication of UTF-8 characters in the body text is done through the presence of either the X-FTN-CHRS: UTF-8 4 header field or a Content-Type: text/*; charset=utf-8 header field.

The key: value pairs within each section of the HEADERS.DAT file correlates with the message at the corresponding byte-offset in the section name. So, for example:

[c80]
Message-ID: <5D4AFDF1.40645.dove_dove-gen@somebbs.com>
WhenWritten:  20190807093601-0700  c1e0
WhenImported: 20190807093601-0700  c1e0
WhenExported: 20190807095552-0700  c1e0

In this example, the Message-ID header field is the full RFC822-style message-ID associated with the messages in the MESSAGES.DAT a byte-offset 0xC80. The WhenWritten/Imported/Exported header fields provide detailed date, time, and timezone information about when the message was written, imported into the original system's message base, and exported out of the original message base (e.g. to a message network).

When a header field is present in the HEADERS.DAT file, it takes precedence over that same header field in either the MESSAGES.DAT header block or any kludge lines that may have been included in the message text (from the message's body blocks).

The following is a complete list of supported header fields within sections of the HEADERS.DAT file:

Additional keys may be included representing not otherwise specified Internet (RFC822-style) header fields.

The VOTING.DAT file is a more recent addition to the QWK packet format (introduced with Synchronet v3.17) and it contains information about message-based voting:

• Polls
• Poll-closures
• Ballots (votes on polls)
• Message up/down-votes

Very similar to the HEADERS.DAT file, the VOTING.DAT file is a text file (with CRLF or LF-terminated lines), in .ini file format. A vote-message header block is identified in a QWK header block with a Message Status value of ”V“ (ASCII 86). The vote section of interest is located in the VOTING.DAT file by first locating the section with the corresponding header block byte-offset in hexadecimal (e.g. [f00]), and then immediately following that section label, will be another section that identifies the type of vote message and this section will contain the relevant key/value pairs:

A VOTING.DAT poll section ([poll:<id>]) may contain the following keys/values:

A poll is closed by a subsequent [close:<id>] vote-message-section which may occur at any later point in time (e.g. even in later QWK packets, received weeks or months later) and once discovered should mark the original poll (identified with the In-Reply-To key value) as unavailable for new ballot submissions.

Ballot message sections are identified by a [vote:<id>] section. There are 2 possible types of ballots:

1. Poll Ballots: contain a “Votes” key
2. Message Ballots: contain an “UpVote = true” or a “DownVote = true” key/value pair

Poll ballots are to be applied to the open-poll referenced by the “In-Reply-To” value. If the poll has been closed, then the ballot is ignored. The “Votes” key value is a bit-field (normally in hexadecimal representation with “0x” prefix), indicating which vote options the voter has selected (bit-0 = PollAnswer0, bit-1 = PollAnswer1, etc.).

Message ballots are simply up/down-votes to be applied to a message's popularity score. The message being voted on is referenced by the “In-Reply-To” message-ID value. If the referenced message doesn't exist, the vote is ignored. The “Sender” key/value identifies the voter. Messages are never closed to new ballots, but voters should not be allowed to submit more than one ballot per message.

The .NDX (index) files contained in QWK packets are of a notoriously bad format. These files contain byte offsets into the MESSAGES.DAT file, which is fine. But these offsets are stored as 32-bit real numbers in an obsolete “Microsoft Binary Format”. Additionally, each record contain a conference number, but that conference number is only 8-bit, limiting its usefulness to only 256 possible message areas.

Some message reader do not require or can be configured to ignore these .NDX files. There is no unique information stored in the .NDX files, so it's entirely possible for any consumer of QWK packets to be programmed to create their own useful index information on-the-fly (e.g. the first time the packet is opened).

Synchronet does not parse or use .NDX files in any way.

The NETFLAGS.DAT is of questionable usefulness or value. Synchronet creates this file only for QWK packets destined for QWK network nodes (all bytes containing 0x01). Synchronet does not read or use this file from incoming packets.

Optional bulletin files (in CRLF text format) may also be found in QWK packets. For example:

Other files found in a QWK packet were usually placed there because the user requested them to be included (e.g. from a download queue) or they were attached to messages included in the packet.

REP (reply) packets are typically created by a user using an offline mail reader or by a system participating as a down-stream node in a message network using QWK packet technology (e.g. DOVE-Net).

The files that may be contained within a Reply packet (archive) include:

• ftp://vert.synchro.net/main/BBS/QWKSPC11.ZIP
• ftp://vert.synchro.net/modem.madness/SMMNETML/QWKINFO.ZIP
• ftp://vert.synchro.net/modem.madness/SMMNETML/QWKLAY16.ZIP
• ftp://vert.synchro.net/modem.madness/SMMOLMRS/QWKDOCS.ZIP
• ftp://vert.synchro.net/modem.madness/SMMMAXIM/MXMS_161.ZIP

• ftp://vert.synchro.net/main/BBS/qwke.txt.

• Synchronet QWK Networking Extensions
• DOVE-Net
• Reference Library