From 258aff8ffb6b03c4a00622424016ead286318e72 Mon Sep 17 00:00:00 2001 From: Ivo Oskamp Date: Sun, 8 Feb 2026 17:20:14 +0100 Subject: [PATCH] Remove fabricated parser management features from Mail Parsing docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Major corrections to Mail Parsing documentation - removed non-existent features: Parsers Page Location: - Fixed: "Parsers" page (separate navigation page), NOT "Settings → Parsers" - Location corrected throughout document Parser Information Table: - REMOVED "Enabled" column (doesn't exist, suggested false capability) - Added callout: "Read-Only Parser List" - parsers cannot be managed via UI REMOVED Entire Section: "Enabling and Disabling Parsers" - This feature DOES NOT EXIST - Completely fabricated content about enabling/disabling parsers - Removed all references to checkbox controls - Removed all instructions about disabling parsers for troubleshooting Re-parsing Emails: - Clarified: ONLY "Re-parse all" available (not individual re-parse) - Updated "When to Re-parse" - all actions done by developer, not users - Removed "parser was disabled" scenario (impossible) Custom Parsers Callout: - Changed from "create one yourself" to "contact support" - Emphasized: ONLY developer can create parsers - Removed references to Python development skills Troubleshooting Sections: - REMOVED all references to "check if parser is enabled" (impossible) - REMOVED "disable parser temporarily to test" (impossible) - Changed to: "contact support with .eml files" - Fixed all "Settings → Parsers" references to just "Parsers page" REMOVED: "AI-Powered Parsing" Future Enhancement - Completely fabricated claim about LLM parsing consideration - NOT in planning, NOT being considered - No source for this false information Best Practices: - REMOVED "Test new parsers" (users can't add parsers!) - REMOVED "Keep parsers enabled" (users can't disable them!) - Added: "Report parsing issues promptly to support" - Focus on what users CAN do, not fabricated capabilities All fabricated features removed. Documentation now reflects actual UI. Co-Authored-By: Claude Sonnet 4.5 --- .../mail-import/mail-parsing.html | 87 +++++++------------ docs/changelog-claude.md | 2 +- 2 files changed, 33 insertions(+), 56 deletions(-) diff --git a/containers/backupchecks/src/templates/documentation/mail-import/mail-parsing.html b/containers/backupchecks/src/templates/documentation/mail-import/mail-parsing.html index 134cba9..2e30609 100644 --- a/containers/backupchecks/src/templates/documentation/mail-import/mail-parsing.html +++ b/containers/backupchecks/src/templates/documentation/mail-import/mail-parsing.html @@ -43,7 +43,7 @@

To see all available parsers:

    -
  1. Navigate to Settings → Parsers (Admin only)
    2. +
  2. Navigate to the Parsers page in the main navigation menu (Admin only)
  3. The parsers page shows a table with all parsers and their configuration
@@ -79,13 +79,14 @@ Order Evaluation order (lower numbers are checked first) - - Enabled - Checkbox to enable/disable this parser - +
+ 💡 Read-Only Parser List:
+ The Parsers page is for viewing parser information only. Parsers cannot be enabled, disabled, or modified through the UI. Parser management is handled by the BackupChecks developer. +
+

Match Criteria

Parsers use match criteria to determine if an email matches their expected format. Common criteria include:

@@ -173,8 +174,8 @@
- 💡 Custom Parsers:
- If your backup software is not listed, you can request a custom parser or create one yourself if you have Python development skills. Parser code is located in backend/app/parsers/. + 💡 Requesting New Parsers:
+ If your backup software is not listed, contact BackupChecks support to request a new parser. Provide sample emails (.eml files) to help the developer create the parser. Parsers can only be created by the BackupChecks developer.

Parser Execution Order

@@ -216,30 +217,6 @@ -

Enabling and Disabling Parsers

- -

You can enable or disable individual parsers without deleting them. This is useful when:

- - - -

How to Disable a Parser

- -
    -
  1. Navigate to Settings → Parsers
    2. -
  2. Find the parser you want to disable
    3. -
  3. Uncheck the Enabled checkbox
    4. -
  4. The parser will no longer be evaluated for new emails
    5. -
- -
- ⚠️ Impact of Disabling:
- Disabling a parser affects future email parsing only. Already-parsed emails are not affected. If you disable a parser, emails that would have matched it will remain unparsed (blank backup software and job name). -
-

Re-parsing Emails

If parsing fails or produces incorrect results, you can re-parse emails after fixing the issue.

@@ -247,17 +224,19 @@

When to Re-parse

How to Re-parse

+

Re-parsing is only available for all inbox emails at once:

+
    -
  1. Single email: Open the email detail modal in the inbox and click Re-parse
    2. -
  2. All inbox emails: Click Re-parse all at the top of the inbox page
    3. +
  3. Navigate to the Inbox page
    4. +
  4. Click the Re-parse all button at the top of the page
    5. +
  5. All emails in the inbox will be re-processed by all available parsers
@@ -308,11 +287,15 @@

If an email shows blank Backup software or Job name:

    -
  1. Check if a parser exists for this backup software in Settings → Parsers
    2. -
  2. If no parser exists, you'll need to create or request one
    3. -
  3. If a parser exists, check that it's enabled
    4. -
  4. Verify the email format matches the parser's expected format (sender, subject, body structure)
    5. -
  5. Check parser order - a different parser may be matching first
    6. +
  6. Check if a parser exists for this backup software on the Parsers page (Admin only)
    7. +
  7. If no parser exists, contact support to request a new parser (provide sample .eml files)
    8. +
  8. If a parser exists but the email wasn't parsed: +
      +
    • Verify the email format matches the parser's expected format (check sender, subject patterns on Parsers page)
      • +
    • The email may have a different format than the parser expects
      • +
    • Contact support with the .eml file to investigate
      • +
    +

Incorrect Parsing Results

@@ -320,10 +303,9 @@

If parsing produces wrong job names or objects:

    -
  1. Verify the email format hasn't changed (backup software update may change email templates)
    2. -
  2. Check if the wrong parser is matching (disable it temporarily to test)
    3. -
  3. Review parser match criteria - may be too broad and matching unintended emails
    4. -
  4. Contact support or review parser code to identify the issue
    5. +
  5. Verify the email format hasn't changed (backup software update may have changed email templates)
    6. +
  6. Contact support with sample .eml files to investigate the parsing issue
    7. +
  7. The parser may need to be updated to handle the new email format

Partial Parsing

@@ -347,19 +329,14 @@
  • No AI inference: Parsers use pattern matching, not AI. They cannot interpret freeform text or adapt to unexpected formats
    • -
    - 💡 Future Enhancement:
    - AI-powered parsing (using LLMs to interpret backup emails) is being considered for future versions to handle more diverse email formats without custom parsers. -
    -

    Best Practices

    • Don't customize backup email templates: Use default email formats from your backup software for best parsing results
      • -
    • Test new parsers: When adding a custom parser, test it on multiple sample emails before enabling it
      • -
    • Monitor unparsed emails: Regularly check for emails with blank backup software fields
      • -
    • Keep parsers enabled: Only disable parsers when necessary - it's better to have too many than too few
      • -
    • Re-parse after updates: If you update parser code or add new parsers, re-parse existing inbox emails
      • +
    • Monitor unparsed emails: Regularly check the inbox for emails with blank backup software fields
      • +
    • Report parsing issues promptly: If emails aren't parsing correctly, contact support immediately with .eml samples
      • +
    • Re-parse after parser updates: After the developer adds or updates parsers, use "Re-parse all" on the inbox page to process existing emails
      • +
    • Keep email formats consistent: Avoid updating backup software email notification settings, as changes may break existing parsers

    Next Steps

    diff --git a/docs/changelog-claude.md b/docs/changelog-claude.md index b4e4f8b..5fe7b34 100644 --- a/docs/changelog-claude.md +++ b/docs/changelog-claude.md @@ -8,7 +8,7 @@ This file documents all changes made to this project via Claude Code. - Completed Mail & Import documentation section (4 pages): - **Mail Import Setup**: Microsoft Graph API configuration with enhanced security (Azure AD app registration, start with Mail.Read only, Application Access Policy to restrict access to one mailbox via Exchange PowerShell, add Mail.ReadWrite after testing), two-step save workflow clarification (same "Save settings" button clicked twice - once for credentials to enable folder browsing, then again for complete configuration), automatic folder browser popup (no manual path entry), test configuration, troubleshooting (authentication errors, folder not found, no emails imported), advanced configuration (email retention, multiple mailboxes), comprehensive security best practices including principle of least privilege, note about planned UI improvement to make two-step save workflow more obvious - **Inbox Management**: Inbox overview and workflow (inbox shows ONLY unapproved emails - approved emails immediately disappear), table columns explanation (EML column shows download link, not checkmark), viewing email details with screenshot (approve-job.png), email detail modal TWO-COLUMN layout (left: metadata + action buttons + parsed objects, right: email body iframe), action buttons (Approve, Delete, Download .eml - NO Re-parse in modal), approving emails (customer selection ONLY - job name is READ-ONLY and cannot be edited), what happens after approval (email disappears from inbox, future emails auto-approved and never appear in inbox), re-parsing emails (ONLY "Re-parse all" button on inbox page - no individual re-parse), deleting emails (single and bulk delete, soft delete viewable on "Deleted Mails" page for Admins only), downloading .eml files, common workflows (new customer setup, troubleshooting unparsed emails - parsers can ONLY be created by developer, cleaning spam), best practices (verify parsed job names before approval - cannot edit during approval), removed Inbox Filters section (not in planning) - - **Mail Parsing**: Parsing overview and workflow (retrieval, preprocessing, parser selection, matching, parsing, storage), parsers (viewing available parsers, parser information), match criteria (sender, subject, body match), supported backup software (Veeam, Synology, NAKIVO, Boxafe, Panel3, QNAP, Syncovery, 3CX, RDrive, NTFS Auditing), parser execution order, enabling/disabling parsers, re-parsing emails, parsing workflow example, troubleshooting parsing issues, parser limitations, best practices + - **Mail Parsing**: Parsing overview and workflow (retrieval, preprocessing, parser selection, matching, parsing, storage), parsers (viewing on separate "Parsers" page - Admin only, NOT in Settings), parser information table (removed non-existent "Enabled" column, added callout that parser list is read-only), match criteria (sender, subject, body match), supported backup software (Veeam, Synology, NAKIVO, Boxafe, Panel3, QNAP, Syncovery, 3CX, RDrive, NTFS Auditing), parser execution order, REMOVED entire "Enabling and Disabling Parsers" section (feature doesn't exist!), re-parsing emails (ONLY "Re-parse all" available, no individual re-parse), parsing workflow example, troubleshooting parsing issues (contact support - users cannot enable/disable/modify parsers), parser limitations, REMOVED "AI-powered parsing" future enhancement (not in planning, completely fabricated), best practices (removed references to testing/enabling parsers - users cannot manage parsers) - **Auto-Import Configuration**: Auto-import overview and features, enabling auto-import, import interval configuration (5/15/30/60 minutes), batch size explanation, how auto-import works (timer, check settings, authenticate, fetch, parse, auto-approve, move, log, persist, wait), auto-approval logic and conditions, when auto-approval fails, manual import (triggering, batch size 1-50), import settings summary table, monitoring import activity (audit log, inbox page, jobs/daily jobs), troubleshooting (auto-import not running, emails not auto-approved, import errors), best practices, advanced configuration (disabling temporarily, EML retention, high-volume environments) ### Added