Skip to main content

Custom e-mail parser for Paperless-ngx

This parser is based on the default e-mail parser of Paperless-ngx and can be used as an alternative to it.

Features

  • If consumption scope isn't EVERYTHING (i.e. parse mail and attachments separately) include attachments in the archived document where possible. If an attachment can't be converted to pdf, include a corresponding note in the archived version. Signature attachments (mime type: application/x-pkcs7-signature) are always excluded.

  • Place a header in front of the pdf containing the text version of the e-mail as well as in front of the html-version.

  • Only include either the text or html version of the e-mail in the archived document. The PDF-Layout values for Paperless-ngx PdfLayout.TEXT_HTML and PdfLayout.HTML_TEXT are therefore interpreted as "if available, use text, else use html version" resp. "if available, use html, else use text version".

  • Preserve original html e-mail content as far as possible. PDF/A version is created using ghostscript preserving links included in the e-mail.

Prerequisites

Installation

pip install paperlessngx-mail-parser

For docker based installations use custom container initialization as described here: https://docs.paperless-ngx.com/advanced_usage/#custom-container-initialization

Place a script with the following content in the directory for your container initialization scripts and make it executable:

#!/bin/bash
pip install paperlessngx-mail-parser

Release files for paperlessngx-mail-parser 3.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for paperlessngx-mail-parser 3.0.1
File Size Uploaded
paperlessngx_mail_parser-3.0.1.tar.gz 19.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for paperlessngx-mail-parser 3.0.1
File Interpreter ABI Platform
paperlessngx_mail_parser-3.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 39.4 kB

Release files / paperlessngx_mail_parser-3.0.1.tar.gz

Download URL paperlessngx_mail_parser-3.0.1.tar.gz
Size 19.0 kB
Tags Source
SHA-256 checksum
How to use checksums
dd8d75fa61693dd6740ed54030f3db159afaa22e466854b00cce7d5d99de47c3
BLAKE2b-256 checksum
How to use checksums
93443c4ad529cda55f049e08c781a0b302c836d1de98879b7c0bc5c12a61e6ee
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release files / paperlessngx_mail_parser-3.0.1-py3-none-any.whl

Download URL paperlessngx_mail_parser-3.0.1-py3-none-any.whl
Size 20.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
cae80b533b0759d656efa3fda80de57ea66266e26ee24864245c489f10a11eee
BLAKE2b-256 checksum
How to use checksums
913ae0009c6f42f57cdd0460d0ccad72bb85aa2a2d7492d6e8ec407dc5e4c281
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.12.3

Release history Release notifications | RSS feed

3.0.2

2 release files

This release

3.0.1 This release

2 release files

3.0.0

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page