QMail Peek — Group 6, Code 73

Non-blocking inbox check. The client asks the recipient’s beacon RAIDA for all pending .tell2 notifications newer than a caller-supplied timestamp. The server returns immediately with a tell-list response, or an empty tell-list if there is no matching mail.

Quick reference

Command Group6 (QMail)
Command Code73 (0x49)
Server functioncmd_qmail_peek2 in cmd_qmail.c
Request packet32-byte plaintext RAIDA header + encrypted body fields + plaintext 3E 3E terminator
Request body size54 bytes total: encrypted challenge(16) + qmail identity/auth(32) + since_timestamp(4), then plaintext terminator(2)
Response packet32-byte plaintext RAIDA response header + encrypted tell-list payload + plaintext 3E 3E terminator
EncryptionRequired — AES-128-CTR, type 1, keyed by the caller’s selected coin AN for this RAIDA
Side effect on successEach returned .tell2 file is queued for deletion after it is read into the response

Purpose

peek is the non-blocking version of ping. It scans the recipient mailbox directory immediately, returns every .tell2 file whose filesystem modification time is greater than since_timestamp, and then closes the request. Pass 0 to return every tell currently in the inbox.

The server path is selected from the mailbox identity in the request body: QMAIL_MAILBOX_ROOT/{denom_hex}/{serial_number}/inbox/. The request must be sent to the recipient’s beacon RAIDA; other RAIDAs may not have that mailbox coin loaded.

Wire packet

The word header is used carefully on this page. The RAIDA packet header is the 32 plaintext bytes at the front of the TCP packet. The 16-byte challenge/CRC is encrypted with the rest of the request body. raidax groups that challenge with the QMail identity block and calls those first 48 decrypted body bytes qmail_preamble_t.

QMail Peek request packet, bytes on TCP

+-------------------------------+-----------------------------------------+----------------------+
| RAIDA request header           | encrypted request body                  | plaintext terminator |
| 32 bytes                       | 52 bytes                                | 2 bytes              |
+-------------------------------+-----------------------------------------+----------------------+
| command group=6, command=73    | challenge/CRC(16)                       | 3E 3E                |
| encryption type=1              | QMail identity/auth block(32)           |                      |
| body_size=54                   | since_timestamp(4)                      |                      |
| nonce(8)                       |                                         |                      |
+-------------------------------+-----------------------------------------+----------------------+

The header’s body_size field includes the encrypted body bytes and the terminator, so for peek it is always 54 (0x0036) in current rest_core.

Request header (32 bytes, plaintext)

OffsetSizeFieldPeek value / meaning
01Router version0x01
11Split ID0x00 for the standard single-frame request
21RAIDA IDTarget beacon RAIDA index, 0–24
31Shard IDCurrent rest_core sends shard 0x03
41Command Group0x06 (QMail)
51Command Code0x49 (73, peek)
6–72Coin ID00 06 CloudCoin network ID
81Bitfield0x01
9–157ReservedZero-filled by rest_core
161Encryption type0x01 AES-128-CTR with coin AN
171Encryption key denominationDenomination of the coin used for wire encryption
18–214Encryption key SNSerial number of the coin used for wire encryption, big-endian
22–232Body size00 36 for peek (54 bytes)
24–318NonceAES-CTR nonce used to encrypt/decrypt the request body

Request body (54 bytes after the RAIDA header)

Decrypted request body layout

+-------------------+--------------------------+---------------------+----------------------+
| challenge/CRC     | QMail identity/auth      | since_timestamp     | terminator           |
| 16 bytes          | 32 bytes                 | 4 bytes             | 2 bytes              |
| encrypted         | encrypted                | encrypted           | plaintext            |
+-------------------+--------------------------+---------------------+----------------------+
| body[0..15]       | body[16..47]             | body[48..51]        | body[52..53]         |
+-------------------+--------------------------+---------------------+----------------------+
Body offsetSizeEncrypted?FieldDescription
0–1112YesChallenge randomRandom bytes generated by the client.
12–154YesChallenge CRC32Big-endian CRC32 of body bytes 0–11. The server verifies this after decrypting.
16–238YesSession IDAll zeros for current QMail AES-128 requests.
24–252YesCoin Type00 06.
261YesMailbox denominationRecipient mailbox coin denomination.
27–304YesMailbox serial numberRecipient mailbox serial number, big-endian.
311YesReservedWas Device ID. Current server ignores it; clients should write zero.
32–4716YesAuthenticity NumberThe mailbox coin AN for this RAIDA. After decryption, process_inbox_scan() compares it to the stored AN for the body’s denomination/SN.
48–514Yessince_timestampBig-endian Unix seconds. The server returns only .tell2 files with st_mtime > since_timestamp.
52–532NoTerminatorFixed 3E 3E. Included in body_size but not encrypted.

raidax names body offsets 0–47 qmail_preamble_t. In the terminology above, the challenge is still body data because it is encrypted with the rest of the body fields.

Response packet

For encryption type 1, the response has the same legacy 32-byte RAIDA header size. If the command returns a tell-list payload, the server encrypts the payload bytes and appends an unencrypted 3E 3E terminator.

QMail Peek response packet, bytes on TCP

+-------------------------------+-----------------------------------------+----------------------+
| RAIDA response header          | encrypted tell-list payload             | plaintext terminator |
| 32 bytes                       | payload_len bytes                       | 2 bytes              |
+-------------------------------+-----------------------------------------+----------------------+
| status, group, body_size       | array header(8)                         | 3E 3E                |
| execution time                 | record 1                                |                      |
| challenge signature            | record 2                                |                      |
|                                | ...                                     |                      |
+-------------------------------+-----------------------------------------+----------------------+

The response header’s 3-byte body size is payload_len + 2. For an empty successful peek, payload_len is 8 and the response body size is 10.

Response header (32 bytes, plaintext)

OffsetSizeFieldDescription
01RAIDA IDResponding RAIDA index.
11Shard IDLegacy response path writes zero.
21Status0xFA on success, or an error code.
31Command Group0x06.
4–52Frame countLegacy response writes 00 01.
6–72Echo bytesEchoes legacy request bytes 30–31.
81ReservedZero.
9–113Body sizeBig-endian length of encrypted payload plus terminator.
12–154Execution timeServer execution time in microseconds, big-endian.
16–3116Challenge signatureLegacy response signature used by the client to verify the response belongs to the request.

Tell-list payload (encrypted)

Decrypted tell-list payload

+----------------------+--------------------------------------+--------------------------------+
| Array header          | Tell record 1                        | Tell record 2 ...              |
| 8 bytes               | 64 + (M * 32) + 18 bytes             | variable                       |
+----------------------+--------------------------------------+--------------------------------+
Payload offsetSizeFieldDescription
01tell_countNumber of tell records following this array header.
1–22total_tellsCurrently zero-filled by the server.
3–75reservedZero-filled.
8...Variabletell recordstell_count records, each parsed using the record structure below.

If the inbox directory does not exist or contains no matching files, the server returns STATUS_SUCCESS with an 8-byte all-zero payload (tell_count = 0). That is a successful empty peek.

Tell record structure

Each returned record is the full contents of one .tell2 file. The server does not add a per-record length field. The client must read byte 29 of the 64-byte file header (stripe_count, called M below) and compute the record size:

record_size = 64 + (M * 32) + 18

+-------------------------+-----------------------------+-----------------------------+
| QMail file header        | server location entries      | recipient footer            |
| 64 bytes                 | M entries * 32 bytes         | 18 bytes                    |
+-------------------------+-----------------------------+-----------------------------+

QMail file header (64 bytes)

Record offsetSizeFieldDescription
0–1516email_idMessage/file GUID. Used by download to fetch stored stripes.
16–172sender_coin_id00 06.
181sender_denominationSender mailbox denomination.
19–224sender_serial_numberSender mailbox serial number, big-endian.
231sender_device_idDevice tag copied from the tell blob. Logged, not enforced.
24–274timestampSender timestamp, big-endian Unix seconds.
281tell_typeCurrent QMail email tells use 0.
291stripe_count (M)Number of 32-byte server entries following this header. The tell sender validated this as 1–32.
30–4516locker_codeLocker/download key copied into the notification. The receiver passes this to download.
46–494total_file_sizeOriginal total file/group size, big-endian.
501version0x02.
51–6313reservedPass-through reserved bytes.

Server location entry (32 bytes each)

There are M entries immediately after the file header. This structure tells the recipient which RAIDA servers hold the stripes and how to connect to them for download.

Entry offsetSizeFieldDescription
01stripe_indexStripe number within the file’s stripe set.
11stripe_typeCurrent rest_core writes 0 for data and 1 for parity.
21server_idRAIDA index holding this stripe. This is stored in the first byte of the legacy stripe_id field.
3–97stripe_id reservedCurrently zero-filled by rest_core.
10–1910IPv6 prefixZero-filled for IPv4-mapped addresses.
20–212IPv4 markerFF FF for IPv4-mapped address.
22–254IPv4 addressStorage RAIDA IPv4 octets.
26–272PortStorage RAIDA TCP port, big-endian.
28–314reservedZero-filled by rest_core.

Recipient footer (18 bytes)

The beacon appends this footer when writing each recipient’s .tell2 file. A receiver must skip these 18 bytes before parsing the next tell record.

Footer offsetSizeFieldDescription
01tag0x50.
11length16.
2–1716receiver_lockerPer-recipient locker/payment key copied from the tell address entry.

Status codes

DecimalHexSymbolMeaning
2500xFASTATUS_SUCCESSInbox scanned. Response payload is the tell-list, possibly empty.
80x08ERROR_COIN_NOT_FOUNDMailbox (denom, SN) from the body is not loaded on this RAIDA.
160x10ERROR_INVALID_PACKET_LENGTHRequest body is shorter than the required 48 + 4 + 2 bytes.
330x21ERROR_INVALID_EOFProtocol terminator was not 3E 3E.
340x22ERROR_INVALID_ENCRYPTIONServer could not decrypt/validate the body before reaching cmd_qmail_peek2.
370x25ERROR_INVALID_CRCThe decrypted challenge CRC did not match.
1940xC2ERROR_FILESYSTEMInbox opendir() failed for a reason other than ENOENT.
2000xC8ERROR_INVALID_ANBody AN does not match the server’s stored AN for the body denomination/SN.
2540xFEERROR_MEMORY_ALLOCServer response buffer allocation failed.

The per-coin rate limiter can silently drop excessive requests by closing the connection without a status response.

Common mistakes

Confusing the packet header with qmail_preamble_t

The 32-byte RAIDA header is plaintext. The server’s 48-byte qmail_preamble_t is decrypted body data: challenge/CRC plus the QMail identity/auth block.

Forgetting that the terminator is not encrypted

The header body-size field includes the final 3E 3E, but AES-128-CTR is applied only to the bytes before it.

Parsing tell records without skipping the footer

Each record ends with an 18-byte recipient footer. Even if a client does not consume that footer, it must skip it before reading the next 64-byte file header.

Empty response is success

STATUS_SUCCESS with tell_count = 0 means the inbox was scanned and no matching tells were found.

Points of confusion

  1. Filter is mtime-based. The server compares each .tell2 file’s st_mtime to since_timestamp. It does not compare the timestamp embedded in the tell file header.
  2. Tells are deleted on read. A successful peek queues returned files for deletion after directory scanning. Multiple devices sharing one mailbox can race; only the first device receives a given tell.
  3. Records are variable length. There is no length prefix per record. Use stripe_count from the file header to compute 64 + M*32 + 18.
  4. The response can be capped. The server stops growing the response at its maximum tell response size; remaining tell files stay in the inbox for a later call.
  5. peek2 is the active command. The suffix is historical. Group 6 code 73 dispatches to cmd_qmail_peek2.