email-forward-parser 0.1.3__py3-none-any.whl

email_forward_parser-0.1.3.dist-info/METADATA

@@ -0,0 +1,577 @@
+Metadata-Version: 2.4
+Name: email-forward-parser
+Version: 0.1.3
+Summary: Python Library to parse forwarded email messages
+Project-URL: Homepage, https://github.com/felipehertzer/email-forward-parser-py
+Project-URL: Repository, https://github.com/felipehertzer/email-forward-parser-py
+Project-URL: Issues, https://github.com/felipehertzer/email-forward-parser-py/issues
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           Licensed under the Apache License, Version 2.0 (the "License");
+           you may not use this file except in compliance with the License.
+           You may obtain a copy of the License at
+        
+               http://www.apache.org/licenses/LICENSE-2.0
+        
+           Unless required by applicable law or agreed to in writing, software
+           distributed under the License is distributed on an "AS IS" BASIS,
+           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+           See the License for the specific language governing permissions and
+           limitations under the License.
+License-File: LICENSE
+License-File: NOTICE
+Keywords: email,eml,forwarded-email,mime,parser
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Communications :: Email
+Classifier: Topic :: Text Processing
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: black>=25; extra == 'dev'
+Requires-Dist: isort>=6; extra == 'dev'
+Requires-Dist: mypy>=1.19; extra == 'dev'
+Requires-Dist: ruff>=0.14; extra == 'dev'
+Provides-Extra: test
+Requires-Dist: pytest-cov>=5; extra == 'test'
+Requires-Dist: pytest>=8; extra == 'test'
+Description-Content-Type: text/markdown
+
+# email-forward-parser-py
+
+`email-forward-parser` extracts the original message details from forwarded email
+content. It can work with plain forwarded bodies or full `.eml` messages, including
+common MIME encodings and attached `.eml` files.
+
+The package is useful when you receive emails forwarded by users or mailboxes and
+need to recover the original sender, recipients, subject, sent date, and body.
+
+## Features
+
+- Detects forwarded messages from subject prefixes such as `Fwd:` and `FW:`.
+- Parses forwarded bodies from Gmail, Apple Mail, Outlook/Office 365, Thunderbird,
+  Yahoo Mail, HubSpot, Missive, IONOS, and several localized clients.
+- Extracts original metadata: `From`, `To`, `Cc`, `Subject`, `Date`, and body.
+- Parses full `.eml` messages with MIME decoding.
+- Handles quoted-printable/base64 text bodies and attached `message/rfc822` or
+  `.eml` attachments.
+- Rebuilds an `.eml` string for the original message when a forwarded email is
+  detected.
+- Ships with a 100% statement coverage gate.
+
+## Installation
+
+```bash
+python -m pip install email-forward-parser
+```
+
+Python 3.10 or newer is required.
+
+The distribution name is `email-forward-parser`, but the import package is
+`emailforwardparser`:
+
+```python
+from emailforwardparser.forward_parser import get_forwarded_metadata
+from emailforwardparser.client import EmailParserClient
+```
+
+## Quick Start
+
+Use `get_forwarded_metadata()` when you already have the email body text.
+
+```python
+from emailforwardparser.forward_parser import get_forwarded_metadata
+
+body = """Hi team
+
+---------- Forwarded message ---------
+From: Jane Doe <jane@example.com>
+Date: Mon, 1 Jan 2024 at 12:00 PM
+Subject: Original subject
+To: Bob <bob@example.com>
+Cc: Copy <copy@example.com>
+
+Original body.
+"""
+
+result = get_forwarded_metadata(body, "Fwd: Original subject")
+
+print(result.forwarded)             # True
+print(result.message)               # Hi team
+print(result.email.subject)         # Original subject
+print(result.email.from_.name)      # Jane Doe
+print(result.email.from_.address)   # jane@example.com
+print(result.email.to[0].address)   # bob@example.com
+print(result.email.cc[0].address)   # copy@example.com
+print(result.email.body)            # Original body.
+```
+
+Use `EmailParserClient` when you have a full `.eml` message.
+
+```python
+from emailforwardparser.client import EmailParserClient
+
+client = EmailParserClient()
+
+with open("forwarded.eml", encoding="utf8") as file:
+    raw_eml = file.read()
+
+metadata = client.get_original_metadata(raw_eml)
+
+if metadata.forwarded:
+    print(metadata.email.from_.address)
+    print(metadata.email.subject)
+    print(metadata.email.body)
+```
+
+## API
+
+### `get_forwarded_metadata(body, subject=None)`
+
+Parses a forwarded body string and returns a `ForwardMetadata` dataclass.
+
+```python
+from emailforwardparser.forward_parser import get_forwarded_metadata
+
+result = get_forwarded_metadata(body, subject)
+```
+
+`subject` is optional. Passing it helps the parser detect forwards that have a
+forwarded subject prefix but no separator line in the body.
+
+### `ForwardMetadata`
+
+```python
+@dataclass
+class ForwardMetadata:
+    forwarded: bool
+    message: str
+    email: OriginalMetadata
+```
+
+- `forwarded`: `True` when forwarded content was detected.
+- `message`: the note written by the person who forwarded the email, before the
+  forwarded block.
+- `email`: metadata extracted from the original email.
+
+### `OriginalMetadata`
+
+```python
+@dataclass
+class OriginalMetadata:
+    date: str
+    subject: str
+    body: str
+    from_: MailboxResult
+    to: list[MailboxResult]
+    cc: list[MailboxResult]
+```
+
+The sender field is named `from_` because `from` is a Python keyword.
+
+### `MailboxResult`
+
+```python
+@dataclass
+class MailboxResult:
+    name: str
+    address: str
+```
+
+When a mailbox line has no valid email address, `address` is empty and the raw
+value is kept in `name`.
+
+### `EmailParserClient`
+
+`EmailParserClient` is the high-level wrapper for full `.eml` messages.
+
+```python
+from emailforwardparser.client import EmailParserClient
+
+client = EmailParserClient()
+```
+
+Methods:
+
+- `get_original_metadata(email: str) -> ForwardMetadata`
+  Parses a raw `.eml` string and returns metadata for the original email. If the
+  message is not forwarded, it returns metadata for the message itself.
+- `get_original_metadata_from_file(file_path: str) -> ForwardMetadata`
+  Reads a `.eml` file and returns the same metadata object.
+- `get_original_eml(email: str) -> dict`
+  Returns a dictionary with:
+  - `forward`: whether the input was detected as forwarded.
+  - `Send-To`: the first address from the wrapper message's `From` header.
+  - `eml`: a raw `.eml` string for the original message when forwarded, or the
+    input/attached message when not forwarded.
+- `get_original_eml_from_file(file_path: str) -> dict`
+  Reads a `.eml` file and returns the same dictionary.
+
+## Examples
+
+### Parse an Apple Mail Forward Without a Subject
+
+```python
+from emailforwardparser.forward_parser import get_forwarded_metadata
+
+body = """Personal note
+
+Begin forwarded message:
+
+From: Jane Doe <jane@example.com>
+Date: Mon, 1 Jan 2024 at 12:00 PM
+Subject: Original subject
+To: Bob <bob@example.com>
+
+Original body.
+"""
+
+result = get_forwarded_metadata(body)
+
+assert result.forwarded is True
+assert result.message == "Personal note"
+assert result.email.subject == "Original subject"
+assert result.email.from_.address == "jane@example.com"
+```
+
+### Parse a Quoted-Printable `.eml`
+
+```python
+from emailforwardparser.client import EmailParserClient
+
+raw_eml = """From: Forwarder <forwarder@example.com>
+To: parser@example.com
+Subject: Fwd: Original subject
+MIME-Version: 1.0
+Content-Type: text/plain; charset="utf-8"
+Content-Transfer-Encoding: quoted-printable
+
+Hi=0A=0A---------- Forwarded message ---------=0AFrom: Jane Doe <jane@example.com>=
+=0ADate: Mon, 1 Jan 2024 at 12:00 PM=0ASubject: Original subject=0ATo: Bob =
+<bob@example.com>=0A=0AOriginal caf=C3=A9 body.=0A
+"""
+
+metadata = EmailParserClient().get_original_metadata(raw_eml)
+
+assert metadata.forwarded is True
+assert metadata.email.body == "Original café body."
+```
+
+### Rebuild the Original `.eml`
+
+```python
+from email.message import EmailMessage
+
+from emailforwardparser.client import EmailParserClient
+
+message = EmailMessage()
+message["From"] = "Forwarder <forwarder@example.com>"
+message["To"] = "parser@example.com"
+message["Subject"] = "Fwd: Original subject"
+message.set_content("""Hi
+
+---------- Forwarded message ---------
+From: Jane Doe <jane@example.com>
+Date: Mon, 1 Jan 2024 at 12:00 PM
+Subject: Original subject
+To: Bob <bob@example.com>
+
+Original body.
+""")
+
+data = EmailParserClient().get_original_eml(message.as_string())
+
+assert data["forward"] is True
+print(data["eml"])
+```
+
+### Read From a File
+
+```python
+from emailforwardparser.client import EmailParserClient
+
+client = EmailParserClient()
+
+metadata = client.get_original_metadata_from_file("forwarded.eml")
+data = client.get_original_eml_from_file("forwarded.eml")
+
+print(metadata.email.subject)
+print(data["eml"])
+```
+
+### Non-Forwarded Messages
+
+If a message is not forwarded, `forwarded` is `False`. With the client wrapper,
+the returned `email` metadata describes the message itself.
+
+```python
+from emailforwardparser.client import EmailParserClient
+
+metadata = EmailParserClient().get_original_metadata(raw_eml)
+
+if not metadata.forwarded:
+    print("This was not a forwarded message")
+    print(metadata.email.subject)
+```
+
+## Behavior Notes
+
+- Parsing is regex-based. It is designed for common forwarded-message formats,
+  not every possible custom email template.
+- Missing fields are returned as empty strings or empty lists.
+- Multiple `To` and `Cc` recipients are returned in order.
+- The parser normalizes common email encodings and non-breaking spaces.
+- The client prefers the first non-attachment `text/plain` body part when reading
+  multipart `.eml` messages.
+- Attached `.eml` messages are returned directly when present.
+
+## Development
+
+Install the development and test tools:
+
+```bash
+python -m pip install -e ".[dev,test]"
+```
+
+Run the full local quality gate:
+
+```bash
+python -m isort --check-only emailforwardparser tests
+python -m black --check emailforwardparser tests
+python -m ruff check emailforwardparser tests
+python -m mypy
+python -m pytest
+```
+
+`pytest` is configured to require 100% statement coverage.
+
+## Release
+
+Build and verify the distribution:
+
+```bash
+python -m pip install --upgrade build twine
+python -m pytest
+rm -rf dist build
+python -m build
+python -m twine check dist/*
+```
+
+Upload to PyPI:
+
+```bash
+python -m twine upload dist/*
+```
+
+## License and Credits
+
+This project is distributed under the Apache License, Version 2.0. See
+[`LICENSE`](LICENSE) for the full license text.
+
+The project was originally created by Garrett Marking. This fork/package includes
+additional maintenance, packaging, typing, test coverage, and parser/client fixes
+by Felipe Hertzer.
+
+Apache 2.0 allows redistribution and modification, including publishing to PyPI,
+as long as the license conditions are followed. In practice for this package:
+
+- Keep the Apache 2.0 license text with redistributions.
+- Keep existing attribution notices from the source distribution.
+- Keep the `NOTICE` file with source and binary distributions.
+- Make it clear when files have been modified.
+
+For the canonical license terms, refer to the Apache Software Foundation's
+[Apache License 2.0](https://www.apache.org/licenses/LICENSE-2.0) page.

email_forward_parser-0.1.3.dist-info/RECORD

@@ -0,0 +1,11 @@
+emailforwardparser/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+emailforwardparser/client.py,sha256=hOmWpvC91ckPeKdKkIj05hV0Zxl7AcfmzJHNWztCpUs,11717
+emailforwardparser/forward_parser.py,sha256=YRo5g--szHk4fRm486igQ6wAqteZs-MmUE3jay4QQ2w,9151
+emailforwardparser/loop.py,sha256=lwVMnTeIDV36E-8oErfwX89iOi52xxdm9Fh5nsBgxqg,1824
+emailforwardparser/regexs.py,sha256=vLS7KYQz7f7zp2bNA0eR2P9szeKLwPg1KOzXp8mNREQ,30496
+emailforwardparser/utils.py,sha256=vyxQPsBBXVUSgt6I4XduvpnpIkeas6ONr2BD0M3vFzw,2594
+email_forward_parser-0.1.3.dist-info/METADATA,sha256=Vqob2PFPlcay0VR_B7iUaxCH2QHeXGM71UZODV_IJ4g,23770
+email_forward_parser-0.1.3.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
+email_forward_parser-0.1.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+email_forward_parser-0.1.3.dist-info/licenses/NOTICE,sha256=FFI4IBjX9Er0lTMo43u1stID-fXU7uB5Hlpt7zJOFGI,369
+email_forward_parser-0.1.3.dist-info/RECORD,,

email_forward_parser-0.1.3.dist-info/WHEEL

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