Home Mail Room
File scanned post. Scanned letters (PDFs) dropped into Inbound/Incoming are read on this machine by an installed @zts/qianfan-ocr behavior, in batches, and filed into a FileCabinet of sender folders. The scanner reads letters and moves them to ReadyToFile, or to Failed when they cannot be read; the filer files every letter it can on its own and holds the rest for a person; the review behavior serves a local page where a person files or skips the held letters. The process-incoming workflow runs it all.
Global Arguments
| Argument | Type | Description |
|---|---|---|
| inboundDir? | string | Folder holding Incoming, ReadyToFile and Failed; absolute, or relative to the repository |
| ocrBehavior? | string | Name of the @zts/qianfan-ocr behavior that reads the image; create and install it first |
| Argument | Type | Description |
|---|---|---|
| run | string | Name the list incoming-<run>, so concurrent workflow runs keep their own |
| batchSize? | number | Letters read with each load of the model |
| maxBatches? | number | Most batches to list, 0 for all; the rest of Incoming waits for the next run |
| Argument | Type | Description |
|---|---|---|
| list | string | The run listIncoming was given |
| batch | number | Which of the list's batches |
| page? | number | 1-based page to read |
| fraction? | number | Share of the page, from the top, to read first |
| retryFullPage? | boolean | Read the whole page of a letter whose sender or date the top did not show |
| dpi? | number | Render resolution |
| prompt? | string | Replace the letter prompt |
| maxNewTokens? | number | Most tokens the model may generate |
Resources
Files
Global Arguments
| Argument | Type | Description |
|---|---|---|
| scanner? | string | The @zts/home-mail-room/scanner instance that reads the letters |
| inboundDir? | string | Folder holding ReadyToFile, Archived and Skipped; absolute, or relative to the repository |
| cabinetDir? | string | Folder of sender folders letters are filed into; absolute, or relative to the repository |
| retention? | string | How long a filed or skipped letter's record is kept |
| Argument | Type | Description |
|---|---|---|
| decisions | array |
| Argument | Type | Description |
|---|---|---|
| letters | array | Letters whose sender is renamed, with every open letter whose sender was read the same way |
| sender | string | How the sender is written from now on |
Resources
Files
Global Arguments
| Argument | Type | Description |
|---|---|---|
| filer? | string | The @zts/home-mail-room/filer instance whose letters are reviewed |
| Argument | Type | Description |
|---|---|---|
| port? | coerce.number | The port on 127.0.0.1; 0 picks a free one |
Read every scanned letter in Inbound/Incoming, a batch at a time, then file everything waiting in ReadyToFile. Each batch is one step: the scanner reads its letters with one load of the OCR model and moves them to ReadyToFile, or to Failed when they cannot be read. A batch that fails leaves its letters in Incoming and the run goes on to the next. The filer then files every letter it can, including ones left by earlier runs, and holds the rest for the review page. Uses the behaviors named scanner
The filer's letters: what its last run did, which wait for review, and which were filed or skipped, by whom
What a process-incoming run did with each letter: read, failed or left in Incoming, then filed or held for review
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented0/1missing
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
Spawns a subprocess with Deno.Command().
- models/review.ts:278 — no reason given
- (extension) — New extension with no existing users; it targets swamp releases that load the behavior spelling.