RTFDE - RTF Encapsulated HTML Extractor

Warnings

• breaking Starting from version 0.1.0, the `deencapsulate` method strictly requires `bytes` as input. Prior versions accepted string input, which is no longer supported.
  Fix: Ensure all RTF input is converted to `bytes` (e.g., `my_rtf_string.encode('utf-8')`) before being passed to `DeEncapsulator.deencapsulate`.
• gotcha Versions of `rtfde` prior to 0.1.2.2 contained a bug (Issue #34) where invalid Unicode escape sequences within RTF byte strings could lead to parsing errors or incorrect output.
  Fix: Upgrade to version 0.1.2.2 or newer to benefit from the fix for invalid Unicode escape sequence handling.
• gotcha The library is designed to extract HTML from potentially complex and sometimes malformed RTF structures, especially those found in email attachments. Inputting poorly formed RTF may result in partial, incorrect, or no HTML being extracted.
  Fix: Implement robust error handling around `de.deencapsulate()` and validate the extracted HTML content. Consider preprocessing or sanitizing the RTF source if its integrity is frequently questionable.

Install

• pip install rtfde Install stable version

Imports

• DeEncapsulator

  from rtfde.deencapsulate import DeEncapsulator

  The main class is located within the 'deencapsulate' submodule, not directly under the top-level package.

Quickstart

Initialize the DeEncapsulator and pass RTF content as bytes to the `deencapsulate` method to extract the embedded HTML. The library handles the parsing and extraction of the 'htmlrtf' section.

from rtfde.deencapsulate import DeEncapsulator

# Example RTF content (must be bytes)
rtf_bytes = b'{\rtf1\ansi{\fonttbl\f0\fswiss Helvetica;}\pard\ql{\f0\fs24 Hello World!}\par\htmlrtf {\html \pard This is <b>HTML</b> content.}}'

de = DeEncapsulator()
html_content = de.deencapsulate(rtf_bytes)

print(html_content)
# Expected output: 'This is <b>HTML</b> content.'