mailfmt 0.1.0__py3-none-any.whl

mailfmt-0.1.0.dist-info/METADATA

@@ -0,0 +1,184 @@
+Metadata-Version: 2.4
+Name: mailfmt
+Version: 0.1.0
+Summary: Plain text email formatter
+Author-email: Daniel Fichtinger <daniel@ficd.ca>
+License-File: LICENSE
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+<h1>Mail Format</h1>
+
+`mailfmt` is a simple plain text email formatter. It's designed to ensure
+consistent paragraph spacing while preserving markdown syntax, email headers,
+sign-offs, and signature blocks.
+
+By default, this script accepts its input on `stdin` and prints to `stdout`.
+This makes it well suited for use as a formatter with a text editor like Kakoune
+or Helix. It has no dependencies besides the standard Python interpreter, and
+was written and tested against Python 3.13.3.
+
+<!--toc:start-->
+
+- [Features](#features)
+- [Usage](#usage)
+- [Output Example](#output-example)
+- [Markdown Safety](#markdown-safety)
+- [Aerc Integration](#aerc-integration)
+- [Contributing](#contributing)
+
+<!--toc:end-->
+
+## Features
+
+- Wraps emails at specified columns.
+- Automatically reflows paragraphs.
+- Squashes consecutive paragraph breaks.
+- Preserves:
+  - Any long word not broken by spaces (e.g. URLs, email addresses).
+  - Quoted lines.
+  - Indented lines.
+  - Lists.
+  - Markdown-style code blocks.
+  - Usenet-style signature block at EOF.
+  - Sign-offs.
+- If specified, output can be made safe for passing to a Markdown renderer.
+  - Use case: piping the output to `pandoc` to write a `text/html` message. See
+    [Markdown Safety](#markdown-safety).
+
+## Usage
+
+```
+usage: mailfmt [-h] [-w WIDTH] [-b] [--no-replace-whitespace] [--no-reflow]
+               [--no-signoff] [--no-signature] [--no-squash] [-m] [-i INPUT]
+               [-o OUTPUT]
+
+Formatter for plain text email.
+"--no-*" options are NOT passed by default.
+
+options:
+  -h, --help            show this help message and exit
+  -w, --width WIDTH     Text width for wrapping. (default: 74)
+  -b, --break-long-words
+                        Break long words while wrapping. (default: False)
+  --no-replace-whitespace
+                        Don't normalize whitespace when wrapping.
+  --no-reflow           Don't reflow lines.
+  --no-signoff          Don't preserve signoff line breaks.
+  --no-signature        Don't preserve signature block.
+  --no-squash           Don't squash consecutive paragraph breaks.
+  -m, --markdown-safe   Output format safe for Markdown rendering.
+  -i, --input INPUT     Input file. (default: STDIN)
+  -o, --output OUTPUT   Output file. (default: STDOUT)
+
+Author : Daniel Fichtinger
+License: ISC
+Contact: daniel@ficd.ca
+```
+
+## Output Example
+
+Before:
+
+```
+Hey,
+
+This is a really long paragraph with lots of words in it. However, my text editor uses soft-wrapping, so it ends up looking horrible when viewed without wrapping! Additionally,
+if I manually add some line breaks, things start to look _super_ janky!
+
+I can't just pipe this to `fmt` because it may break my beautiful
+markdown
+syntax. Markdown formatters are also problematic because they mess up
+my signoff and signature blocks! What should I do?
+
+Best wishes,
+Daniel
+
+-- 
+Daniel
+sr.ht/~ficd
+daniel@ficd.ca
+```
+
+After:
+
+```
+Hey,
+
+This is a really long paragraph with lots of words in it. However, my text
+editor uses soft-wrapping, so it ends up looking horrible when viewed
+without wrapping! Additionally, if I manually add some line breaks, things
+start to look _super_ janky!
+
+I can't just pipe this to `fmt` because it may break my beautiful markdown
+syntax. Markdown formatters are also problematic because they mess up my
+signoff and signature blocks! What should I do?
+
+Best wishes,
+Daniel
+
+-- 
+Daniel
+sr.ht/~ficd
+daniel@ficd.ca
+```
+
+## Markdown Safety
+
+In some cases, you may want to generate an HTML email. Ideally, you'd want the
+HTML to be generated directly from the plain text message, and for _both_
+versions to be legible and have the same semantics.
+
+Although `mailfmt` was written with Markdown markup in mind, its intended output
+is still the `text/plain` format. If you pass its output directly to a Markdown
+renderer, line breaks in sign-offs and the signature block won't be preserved.
+
+If you invoke `mailfmt --markdown-safe`, then `\` characters will be appended to
+mark line breaks that would otherwise be squashed, making the output suitable
+for conversion into HTML. Here's an example of one such pipeline:
+
+```bash
+cat message.txt | mailfmt --markdown-safe | pandoc -f markdown -t html
+--standalone > message.html
+```
+
+Here's the earlier example message with markdown safe output:
+
+```
+Hey,
+
+This is a really long paragraph with lots of words in it. However, my text
+editor uses soft-wrapping, so it ends up looking horrible when viewed
+without wrapping! Additionally, if I manually add some line breaks, things
+start to look _super_ janky!
+
+I can't just pipe this to `fmt` because it may break my beautiful markdown
+syntax. Markdown formatters are also problematic because they mess up my
+signoff and signature blocks! What should I do?
+
+Best wishes, \
+Daniel \
+
+--  \
+Daniel \
+sr.ht/~ficd \
+daniel@ficd.ca \
+```
+
+## Aerc Integration
+
+For integration with `aerc`, consider adding the following to your `aerc.conf`:
+
+```ini
+[multipart-converters]
+text/html=mailfmt --markdown-safe | pandoc -f markdown -t html --standalone
+```
+
+When you're done writing your email, you can call the `:multipart text/html`
+command to generate a `multipart/alternative` message which includes _both_ your
+original `text/plain` _and_ the newly generated `text/html` content.
+
+## Contributing
+
+Please send patches, requests, and concerns to my
+[public inbox](https://lists.sr.ht/~ficd/public-inbox).

mailfmt-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+mailfmt.py,sha256=auV0gcx7smsNhjbjdL8yNNDVEEidGMwJMB4AsUyBwbk,6500
+mailfmt-0.1.0.dist-info/METADATA,sha256=oJkZ8gCdpMFJOyLXO7BZHYfVoL2x2zZlpRwhSo6fjLg,5587
+mailfmt-0.1.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mailfmt-0.1.0.dist-info/entry_points.txt,sha256=eFkLVHtmLEdRnOOzT4d2pAy7mBkjESW_8VQgUfAWvk4,41
+mailfmt-0.1.0.dist-info/licenses/LICENSE,sha256=M8EhEEXHuRQsNgdRFtF2Ty6P62p8vgDanib1C-Zqkqc,749
+mailfmt-0.1.0.dist-info/RECORD,,

mailfmt-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

mailfmt-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+mailfmt = mailfmt:main

mailfmt-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2025 Daniel Fichtinger <daniel@ficd.ca>
+
+Permission to use, copy, modify, and distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

mailfmt.py

@@ -0,0 +1,230 @@
+#!/bin/env python
+
+# Simple text-wrapping script for email.
+# Preserves code blocks, quotes, and signature.
+# Automatically joins and re-wraps paragraphs to
+# ensure even spacing & avoid ugly wrapping.
+# Preserves signoffs.
+# Signoff heuristic:
+# 1-5 words ending with a comma, followed by
+# 1-5 words that each start with capital letters.
+# Author: Daniel Fichtinger
+# License: ISC
+
+import textwrap
+import sys
+import re
+import argparse
+
+
+def main() -> None:
+    paragraph: list[str] = []
+    skipping = False
+    squash = True
+    prev_is_parbreak = False
+    out_stream = sys.stdout
+    reflow = True
+    width = 74
+    break_long_words = False
+    replace_whitespace = True
+    markdown_safe = False
+
+    in_signoff = False
+    in_signature = False
+
+    def pprint(string: str):
+        if markdown_safe and (in_signoff or in_signature) and string:
+            string += " \\"
+        if not squash:
+            print(string, file=out_stream)
+        else:
+            parbreak = not string
+            nonlocal prev_is_parbreak
+            if skipping or not (parbreak and prev_is_parbreak):
+                print(string, file=out_stream)
+            prev_is_parbreak = parbreak
+
+    def wrap(text: str):
+        return textwrap.wrap(
+            text,
+            width=width,
+            break_long_words=break_long_words,
+            replace_whitespace=replace_whitespace,
+        )
+
+    def flush_paragraph():
+        if paragraph:
+            if reflow:
+                joined = " ".join(paragraph)
+                wrapped = wrap(joined)
+                pprint("\n".join(wrapped))
+            else:
+                for line in paragraph:
+                    for wrapped_line in wrap(line):
+                        pprint(wrapped_line)
+            paragraph.clear()
+
+    signoff_cache: str = ""
+
+    def check_signoff(line: str) -> bool:
+        if not line:
+            return False
+        words = line.split()
+        n = len(words)
+        # first potential signoff line
+        if not signoff_cache and 1 <= n <= 5 and line[-1] == ",":
+            return True
+        # second potential line
+        elif signoff_cache and 1 <= n <= 5 and line[-1].isalpha():
+            for w in words:
+                if not w[0].isupper():
+                    return False
+            return True
+        else:
+            return False
+
+    parser = argparse.ArgumentParser(
+        description='Formatter for plain text email.\n"--no-*" options are NOT passed by default.',
+        epilog="""
+Author : Daniel Fichtinger
+License: ISC
+Contact: daniel@ficd.ca
+        """,
+        formatter_class=argparse.RawDescriptionHelpFormatter,
+    )
+    parser.add_argument(
+        "-w",
+        "--width",
+        required=False,
+        help="Text width for wrapping. (default: %(default)s)",
+        default=width,
+        type=int,
+    )
+    parser.add_argument(
+        "-b",
+        "--break-long-words",
+        required=False,
+        help="Break long words while wrapping. (default: %(default)s)",
+        action="store_true",
+    )
+    parser.add_argument(
+        "--no-replace-whitespace",
+        required=False,
+        help="Don't normalize whitespace when wrapping.",
+        action="store_false",
+    )
+    parser.add_argument(
+        "--no-reflow",
+        required=False,
+        help="Don't reflow lines.",
+        action="store_false",
+    )
+    parser.add_argument(
+        "--no-signoff",
+        required=False,
+        help="Don't preserve signoff line breaks.",
+        action="store_false",
+    )
+    parser.add_argument(
+        "--no-signature",
+        required=False,
+        help="Don't preserve signature block.",
+        action="store_false",
+    )
+    parser.add_argument(
+        "--no-squash",
+        required=False,
+        help="Don't squash consecutive paragraph breaks.",
+        action="store_false",
+    )
+    parser.add_argument(
+        "-m",
+        "--markdown-safe",
+        required=False,
+        help="Output format safe for Markdown rendering.",
+        action="store_true",
+    )
+    parser.add_argument(
+        "-i",
+        "--input",
+        required=False,
+        type=str,
+        default="STDIN",
+        help="Input file. (default: %(default)s)",
+    )
+    parser.add_argument(
+        "-o",
+        "--output",
+        required=False,
+        type=str,
+        default="STDOUT",
+        help="Output file. (default: %(default)s)",
+    )
+    args = parser.parse_args()
+    width = args.width
+    should_check_signoff = args.no_signoff
+    should_check_signature = args.no_signature
+    reflow = args.no_reflow
+    squash = args.no_squash
+    replace_whitespace = args.no_replace_whitespace
+    break_long_words = args.break_long_words
+    markdown_safe = args.markdown_safe
+
+    if args.input == "STDIN":
+        reader = sys.stdin
+    else:
+        with open(args.input, "r") as in_stream:
+            reader = in_stream
+    if args.output != "STDOUT":
+        out_stream = open(args.output, "w")
+
+    for line in reader:
+        line = line.rstrip()
+        if should_check_signoff:
+            is_signoff = check_signoff(line)
+            if is_signoff:
+                in_signoff = True
+                if not signoff_cache:
+                    signoff_cache = line
+                else:
+                    pprint(signoff_cache)
+                    pprint(line)
+                    in_signoff = False
+                    signoff_cache = ""
+                continue
+            elif not is_signoff and signoff_cache:
+                paragraph.append(signoff_cache)
+                signoff_cache = ""
+                in_signoff = False
+        if line.startswith("```"):
+            flush_paragraph()
+            skipping = not skipping
+            pprint(line)
+        elif should_check_signature and line == "--":
+            flush_paragraph()
+            skipping = True
+            in_signature = True
+            pprint("-- ")
+        elif not line or re.match(
+            r"^(\s+|-\s+|\+\s+|\*\s+|>\s*|#\s+|From:|To:|Cc:|Bcc:|Subject:|Reply-To:|In-Reply-To:|References:|Date:|Message-Id:|User-Agent:)",
+            line,
+        ):
+            flush_paragraph()
+            pprint(line)
+        elif skipping:
+            pprint(line)
+        else:
+            paragraph.append(line)
+    else:
+        if signoff_cache:
+            paragraph.append(signoff_cache)
+            signoff_cache = ""
+        flush_paragraph()
+    if out_stream is not None:
+        out_stream.close()
+
+
+if __name__ == "__main__":
+    main()
+
+# pyright: basic