mail-parser 3.14.0__tar.gz → 4.0.0__tar.gz

mail_parser-4.0.0/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 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.

mail_parser-4.0.0/NOTICE.txt

@@ -0,0 +1,13 @@
+Copyright 2016 Fedele Mantuano (https://twitter.com/fedelemantuano)
+
+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.

mail_parser-4.0.0/PKG-INFO

@@ -0,0 +1,330 @@
+Metadata-Version: 2.1
+Name: mail-parser
+Version: 4.0.0
+Summary: Improved wrapper for email standard library
+Home-page: https://github.com/SpamScope/mail-parser
+Author: Fedele Mantuano
+Author-email: mantuano.fedele@gmail.com
+Maintainer: Fedele Mantuano
+Maintainer-email: mantuano.fedele@gmail.com
+License: Apache License, Version 2.0
+Keywords: email,mail,parser,spam,phishing,malware,forensic,analysis
+Platform: OS Independent
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+License-File: NOTICE.txt
+Requires-Dist: ipaddress
+Requires-Dist: six
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Provides-Extra: test
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: pytest-mock; extra == "test"
+Requires-Dist: pytest-ordering; extra == "test"
+
+[![PyPI version](https://badge.fury.io/py/mail-parser.svg)](https://badge.fury.io/py/mail-parser)
+[![Coverage Status](https://coveralls.io/repos/github/SpamScope/mail-parser/badge.svg?branch=develop)](https://coveralls.io/github/SpamScope/mail-parser?branch=develop)
+
+![SpamScope](https://raw.githubusercontent.com/SpamScope/spamscope/develop/docs/logo/spamscope.png)
+
+# mail-parser
+
+mail-parser is not only a wrapper for [email](https://docs.python.org/2/library/email.message.html) Python Standard Library.
+It give you an easy way to pass from raw mail to Python object that you can use in your code.
+It's the key module of [SpamScope](https://github.com/SpamScope/spamscope).
+
+mail-parser can parse Outlook email format (.msg). To use this feature, you need to install `libemail-outlook-message-perl` package. For Debian based systems:
+
+```
+$ apt-get install libemail-outlook-message-perl
+```
+
+For more details:
+
+```
+$ apt-cache show libemail-outlook-message-perl
+```
+
+mail-parser supports Python 3.
+
+
+# Apache 2 Open Source License
+mail-parser can be downloaded, used, and modified free of charge. It is available under the Apache 2 license.
+
+## Support the project
+
+[![Donate](https://www.paypal.com/en_US/i/btn/btn_donateCC_LG.gif "Donate")](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=VEPXYP745KJF2)
+
+# mail-parser on Web
+ - [Splunk app](https://splunkbase.splunk.com/app/4129/)
+ - [FreeBSD port](https://www.freshports.org/mail/py-mail-parser/)
+ - [Arch User Repository](https://aur.archlinux.org/packages/mailparser/)
+ - [REMnux](https://docs.remnux.org/discover-the-tools/analyze+documents/email+messages#mail-parser)
+
+# Description
+
+mail-parser takes as input a raw email and generates a parsed object. The properties of this object are the same name of
+[RFC headers](https://www.iana.org/assignments/message-headers/message-headers.xhtml):
+
+  - bcc
+  - cc
+  - date
+  - delivered_to
+  - from\_ (not `from` because is a keyword of Python)
+  - message_id
+  - received
+  - reply_to
+  - subject
+  - to
+
+There are other properties to get:
+  - body
+  - body html
+  - body plain
+  - headers
+  - attachments
+  - sender IP address
+  - to domains
+  - timezone
+
+The `attachments` property is a list of objects. Every object has the following keys:
+  - binary: it's true if the attachment is a binary
+  - charset
+  - content_transfer_encoding
+  - content-disposition
+  - content-id
+  - filename
+  - mail_content_type
+  - payload: attachment payload in base64
+
+To get custom headers you should replace "-" with "\_".
+Example for header `X-MSMail-Priority`:
+
+```
+$ mail.X_MSMail_Priority
+```
+
+The `received` header is parsed and splitted in hop. The fields supported are:
+ - by
+ - date
+ - date_utc
+ - delay (between two hop)
+ - envelope_from
+ - envelope_sender
+ - for
+ - from
+ - hop
+ - with
+
+
+mail-parser can detect defect in mail:
+  - [defects](https://docs.python.org/2/library/email.message.html#email.message.Message.defects): mail with some not compliance RFC part
+
+All properties have a JSON and raw property that you can get with:
+ - name_json
+ - name_raw
+
+Example:
+
+```
+$ mail.to (Python object)
+$ mail.to_json (JSON)
+$ mail.to_raw (raw header)
+```
+
+The command line tool use the JSON format.
+
+## Defects
+These defects can be used to evade the antispam filter. An example are the mails with a malformed boundary that can hide a not legitimate epilogue (often malware).
+This library can take these epilogues.
+
+
+# Authors
+
+## Main Author
+**Fedele Mantuano**: [LinkedIn](https://www.linkedin.com/in/fmantuano/)
+
+
+# Installation
+
+Clone repository
+
+```
+git clone https://github.com/SpamScope/mail-parser.git
+```
+
+and install mail-parser with `setup.py`:
+
+```
+$ cd mail-parser
+
+$ python setup.py install
+```
+
+or use `pip`:
+
+```
+$ pip install mail-parser
+```
+
+# Usage in a project
+
+Import `mailparser` module:
+
+```
+import mailparser
+
+mail = mailparser.parse_from_bytes(byte_mail)
+mail = mailparser.parse_from_file(f)
+mail = mailparser.parse_from_file_msg(outlook_mail)
+mail = mailparser.parse_from_file_obj(fp)
+mail = mailparser.parse_from_string(raw_mail)
+```
+
+Then you can get all parts
+
+```
+mail.attachments: list of all attachments
+mail.body
+mail.date: datetime object in UTC
+mail.defects: defect RFC not compliance
+mail.defects_categories: only defects categories
+mail.delivered_to
+mail.from_
+mail.get_server_ipaddress(trust="my_server_mail_trust")
+mail.headers
+mail.mail: tokenized mail in a object
+mail.message: email.message.Message object
+mail.message_as_string: message as string
+mail.message_id
+mail.received
+mail.subject
+mail.text_plain: only text plain mail parts in a list
+mail.text_html: only text html mail parts in a list
+mail.text_not_managed: all not managed text (check the warning logs to find content subtype)
+mail.to
+mail.to_domains
+mail.timezone: returns the timezone, offset from UTC
+mail.mail_partial: returns only the mains parts of emails
+```
+
+It's possible to write the attachments on disk with the method:
+
+```
+mail.write_attachments(base_path)
+```
+
+# Usage from command-line
+
+If you installed mailparser with `pip` or `setup.py` you can use it with command-line.
+
+These are all swithes:
+
+```
+usage: mailparser [-h] (-f FILE | -s STRING | -k)
+                   [-l {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}] [-j] [-b]
+                   [-a] [-r] [-t] [-dt] [-m] [-u] [-c] [-d] [-o]
+                   [-i Trust mail server string] [-p] [-z] [-v]
+
+Wrapper for email Python Standard Library
+
+optional arguments:
+  -h, --help            show this help message and exit
+  -f FILE, --file FILE  Raw email file (default: None)
+  -s STRING, --string STRING
+                        Raw email string (default: None)
+  -k, --stdin           Enable parsing from stdin (default: False)
+  -l {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}, --log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}
+                        Set log level (default: WARNING)
+  -j, --json            Show the JSON of parsed mail (default: False)
+  -b, --body            Print the body of mail (default: False)
+  -a, --attachments     Print the attachments of mail (default: False)
+  -r, --headers         Print the headers of mail (default: False)
+  -t, --to              Print the to of mail (default: False)
+  -dt, --delivered-to   Print the delivered-to of mail (default: False)
+  -m, --from            Print the from of mail (default: False)
+  -u, --subject         Print the subject of mail (default: False)
+  -c, --receiveds       Print all receiveds of mail (default: False)
+  -d, --defects         Print the defects of mail (default: False)
+  -o, --outlook         Analyze Outlook msg (default: False)
+  -i Trust mail server string, --senderip Trust mail server string
+                        Extract a reliable sender IP address heuristically
+                        (default: None)
+  -p, --mail-hash       Print mail fingerprints without headers (default:
+                        False)
+  -z, --attachments-hash
+                        Print attachments with fingerprints (default: False)
+  -sa, --store-attachments
+                        Store attachments on disk (default: False)
+  -ap ATTACHMENTS_PATH, --attachments-path ATTACHMENTS_PATH
+                        Path where store attachments (default: /tmp)
+  -v, --version         show program's version number and exit
+
+It takes as input a raw mail and generates a parsed object.
+```
+
+Example:
+
+```shell
+$ mailparser -f example_mail -j
+```
+
+This example will show you the tokenized mail in a JSON pretty format.
+
+From [raw mail](https://gist.github.com/fedelemantuano/5dd702004c25a46b2bd60de21e67458e) to
+[parsed mail](https://gist.github.com/fedelemantuano/e958aa2813c898db9d2d09469db8e6f6).
+
+
+# Exceptions
+
+Exceptions hierarchy of mail-parser:
+
+```
+MailParserError: Base MailParser Exception
+|
+\── MailParserOutlookError: Raised with Outlook integration errors
+|
+\── MailParserEnvironmentError: Raised when the environment is not correct
+|
+\── MailParserOSError: Raised when there is an OS error
+|
+\── MailParserReceivedParsingError: Raised when a received header cannot be parsed
+```
+
+# Development
+The first step is to install the development environment:
+
+```
+$ python3.10 -m virtualenv venv
+$ source venv/bin/activate
+$ pip install -e ".[dev, test]"
+```
+
+The second step is to run the tests:
+
+```
+$ make test
+```
+
+Then you can try to run the command line tool:
+
+```
+$ mail-parser -f tests/mails/mail_malformed_3 -j
+```
+
+If all is ok, you can start to develop.

{mail-parser-3.14.0 → mail_parser-4.0.0}/README.md

@@ -1,15 +1,10 @@
 [![PyPI version](https://badge.fury.io/py/mail-parser.svg)](https://badge.fury.io/py/mail-parser)
-[![Build Status](https://travis-ci.org/SpamScope/mail-parser.svg?branch=develop)](https://travis-ci.org/SpamScope/mail-parser)
 [![Coverage Status](https://coveralls.io/repos/github/SpamScope/mail-parser/badge.svg?branch=develop)](https://coveralls.io/github/SpamScope/mail-parser?branch=develop)
-[![BCH compliance](https://bettercodehub.com/edge/badge/SpamScope/mail-parser?branch=develop)](https://bettercodehub.com/)
-[![](https://images.microbadger.com/badges/image/fmantuano/spamscope-mail-parser.svg)](https://microbadger.com/images/fmantuano/spamscope-mail-parser "Get your own image badge on microbadger.com")
 
 ![SpamScope](https://raw.githubusercontent.com/SpamScope/spamscope/develop/docs/logo/spamscope.png)
 
 # mail-parser
 
-## Overview
-
 mail-parser is not only a wrapper for [email](https://docs.python.org/2/library/email.message.html) Python Standard Library.
 It give you an easy way to pass from raw mail to Python object that you can use in your code.
 It's the key module of [SpamScope](https://github.com/SpamScope/spamscope).
@@ -28,15 +23,23 @@ $ apt-cache show libemail-outlook-message-perl
 
 mail-parser supports Python 3.
 
-## mail-parser on Web
+
+# Apache 2 Open Source License
+mail-parser can be downloaded, used, and modified free of charge. It is available under the Apache 2 license.
+
+## Support the project
+
+[![Donate](https://www.paypal.com/en_US/i/btn/btn_donateCC_LG.gif "Donate")](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=VEPXYP745KJF2)
+
+# mail-parser on Web
  - [Splunk app](https://splunkbase.splunk.com/app/4129/)
  - [FreeBSD port](https://www.freshports.org/mail/py-mail-parser/)
  - [Arch User Repository](https://aur.archlinux.org/packages/mailparser/)
+ - [REMnux](https://docs.remnux.org/discover-the-tools/analyze+documents/email+messages#mail-parser)
 
+# Description
 
-## Description
-
-mail-parser takes as input a raw email and generates a parsed object. The properties of this object are the same name of 
+mail-parser takes as input a raw email and generates a parsed object. The properties of this object are the same name of
 [RFC headers](https://www.iana.org/assignments/message-headers/message-headers.xhtml):
 
   - bcc
@@ -107,27 +110,18 @@ $ mail.to_raw (raw header)
 
 The command line tool use the JSON format.
 
-### Defects
+## Defects
 These defects can be used to evade the antispam filter. An example are the mails with a malformed boundary that can hide a not legitimate epilogue (often malware).
 This library can take these epilogues.
 
 
-### Apache 2 Open Source License
-mail-parser can be downloaded, used, and modified free of charge. It is available under the Apache 2 license.
-
-If you want support the project:
-
-
-[![Donate](https://www.paypal.com/en_US/i/btn/btn_donateCC_LG.gif "Donate")](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=VEPXYP745KJF2)
-
-
-## Authors
+# Authors
 
-### Main Author
+## Main Author
 **Fedele Mantuano**: [LinkedIn](https://www.linkedin.com/in/fmantuano/)
 
 
-## Installation
+# Installation
 
 Clone repository
 
@@ -149,7 +143,7 @@ or use `pip`:
 $ pip install mail-parser
 ```
 
-## Usage in a project
+# Usage in a project
 
 Import `mailparser` module:
 
@@ -196,7 +190,7 @@ It's possible to write the attachments on disk with the method:
 mail.write_attachments(base_path)
 ```
 
-## Usage from command-line
+# Usage from command-line
 
 If you installed mailparser with `pip` or `setup.py` you can use it with command-line.
 
@@ -216,7 +210,7 @@ optional arguments:
   -s STRING, --string STRING
                         Raw email string (default: None)
   -k, --stdin           Enable parsing from stdin (default: False)
-  -l {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}, --log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}                                                                                          
+  -l {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}, --log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}
                         Set log level (default: WARNING)
   -j, --json            Show the JSON of parsed mail (default: False)
   -b, --body            Print the body of mail (default: False)
@@ -253,11 +247,11 @@ $ mailparser -f example_mail -j
 
 This example will show you the tokenized mail in a JSON pretty format.
 
-From [raw mail](https://gist.github.com/fedelemantuano/5dd702004c25a46b2bd60de21e67458e) to 
+From [raw mail](https://gist.github.com/fedelemantuano/5dd702004c25a46b2bd60de21e67458e) to
 [parsed mail](https://gist.github.com/fedelemantuano/e958aa2813c898db9d2d09469db8e6f6).
 
 
-## Exceptions
+# Exceptions
 
 Exceptions hierarchy of mail-parser:
 
@@ -272,3 +266,26 @@ MailParserError: Base MailParser Exception
 |
 \── MailParserReceivedParsingError: Raised when a received header cannot be parsed
 ```
+
+# Development
+The first step is to install the development environment:
+
+```
+$ python3.10 -m virtualenv venv
+$ source venv/bin/activate
+$ pip install -e ".[dev, test]"
+```
+
+The second step is to run the tests:
+
+```
+$ make test
+```
+
+Then you can try to run the command line tool:
+
+```
+$ mail-parser -f tests/mails/mail_malformed_3 -j
+```
+
+If all is ok, you can start to develop.

mail_parser-4.0.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools >= 40.6.0", "wheel"]
+build-backend = "setuptools.build_meta"