| Name | emlmailreader JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | Parse EML file and export the information extracted as JSON. |
| upload_time | 2024-03-29 17:36:08 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.12 |
| license | Copyright (c) 2018 The Python Packaging Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
email
reader
eml
parser
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# EMLMailReader
This Python library streamlines the process of working with EML files. Effortlessly extract crucial details like sender and recipient information, subject lines, email bodies, and a complete list of headers. For in-depth analysis, export the parsed data in the widely-used JSON format. Additionally, the library provides the convenience of downloading any associated attachments directly to your local machine for further processing.
## Table of Contents
- [Installation](#installation)
- [Example Usage](#example-usage)
- [Modules Used](#modules-used)
- [Documentation](#documentation)
## Installation
To install the library locally, make sure you have *python* and *pip* installed in your system, and then run the below command.
```
pip install emlmailreader
```
## Example Usage
Here's a sample code to leverage **EMLMailReader** in parsing an EML file and extract information contained within.
```
from EMLMailReader import MailReader, RxMailMessage
reader: MailReader = MailReader()
message = reader.get_email("COMPLETE_EML_FILE_PATH")
if isinstance(message, RxMailMessage):
json_string = message.export_as_json()
print(json_string)
```
In this context, the term "COMPLETE_EML_FILE_PATH" indicates the complete path of the .EML file intended for processing. Running this code will output a JSON string resembling the one provided below.
```
{
"From": "Mahesh Kumaar Balaji <maheshkumaar.balaji@outlook.com>",
"Subject": "Test-Email-5",
"Message-ID": "<TY3P286MB27238431EA4EE3F05821CDD7E4312@TY3P286MB2723.JPNP286.PROD.OUTLOOK.COM>",
"IsMultiPart": true,
"Mime-Version": "1.0",
"Date": "Fri, 22 Mar 2024 22:52:24 +0000",
"Headers": {
"Received": "from TY3P286MB2723.JPNP286.PROD.OUTLOOK.COM([fe80::9b2e:a11f:e0f1:779c]) by TY3P286MB2723.JPNP286.PROD.OUTLOOK.COM([fe80::9b2e:a11f:e0f1:779c%4]) with mapi id 15.20.7409.023; Fri, 22 Mar 202422:52:24 +0000",
"ARC-Seal": "i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none;b=R7Ad8lvJlkvb3ov//iWvUp0UNJBNSuPikhA9JmxzD+mzmKSZBG2O9N6DS3zgrY3FuysknY3gVzCwODU1D5toiiJDJrWOGACizAmxZ6PwB3oCyA6BOGS3c4XIoO9PoN5iibHVgaDYFB+ktslKH0ydWevOFfPH7IQ9jj4yh8hJRm3HlostxLmYufsWtVm6VV16AN222F/31GnJn+ka8Xw5HiEeTooZw1xApc8FF+2ZFgpQWXwQF188LxgPawMRWtsrAxlcGfQ0lZKvOH2xNbyMOwKDwYRiOfjCtIO9jmuhlU+dFOXm5Xsanu9R9WSe8r/s40EU+ym78ZF+id59f4SKfg==",
"ARC-Message-Signature": "i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com;s=arcselector9901;h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1;bh=GZNu+uY4tmf+Dg5UG62PQ4Lx0mkpwlqJV6YZapikb3Y=;b=BPZcx+/mDa/IsQohNF/q8w/Bwdf/xOyrOetQAAgq8WbY8I/0pwd4yuCdEyR5yOShyEyiQZYQdTCLGSXUO6e4ALY7/eu2XUyY6BOmbk7piCMkfWHDCh0dr0dbVHLHV7aAOm+FrNY+id5+6FTu8oTwFLF2gOS5Zdm92VYUgOWJseyZBslgVZGI6lLrgX3zyvEO5YdsZW1rUDuoK1m7h6sZcaYWGdhaZmOZxhGADLQjGKiSxuqXa6gj219qiOshbuYAwUbBrZUlwe//M0wqU7qMpD5HFRZGTnrtFHALX5TW6Aak584tV7SctKIclQNcqiyPXZkPEwYcx35v9EZmBlO/Xg==",
"ARC-Authentication-Results": "i=1; mx.microsoft.com 1; spf=none; dmarc=none;dkim=none; arc=none",
"Authentication-Results": "spf=pass (sender IP is 52.103.66.3)smtp.mailfrom=outlook.com; dkim=pass (signature was verified)header.d=outlook.com;dmarc=pass action=noneheader.from=outlook.com;compauth=pass reason=100",
"Received-SPF": "Pass (protection.outlook.com: domain of outlook.com designates52.103.66.3 as permitted sender) receiver=protection.outlook.com;client-ip=52.103.66.3; helo=OS0P286CU011.outbound.protection.outlook.com;pr=C",
"DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/relaxed; d=outlook.com;s=selector1;h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck;bh=GZNu+uY4tmf+Dg5UG62PQ4Lx0mkpwlqJV6YZapikb3Y=;b=bdqw84toCecsyc1+gQcqkfjw0blT4jfKHQMqmrRiVodhnIU9OcGUzYxsjPjB0w8scHu89+AL12fp4/a/7uLPI9HfoV+VQfWLfkPAJIjrq4dB/RC/pTrXvX7W1ROmQt1Toj5SRss1fXQHYjONBaAOmmHrNstjB3g9gIumNor+fussHVY7lhrj37bg1EjGUrQL5PQ1o4y+29U6Q4UMI3V+ESNgbyRMfqW8BXAaCy6iDHOZuFWS1562hjtDTYHqN9cx+e4X3sY+Z2q+ac3TvxDt5fjbd8ji/hNzAPgIW6ml4XZExyVdWZdNvfY95yvitpO7mfdOAAH8ac5XrYEDJEP/5A==",
"Thread-Topic": "Test-Email-5",
"Thread-Index": "AQHafKt91GiqauDZ2k6oNt2I9lOJUQ==",
"Accept-Language": "en-US",
"Content-Language": "en-US",
"X-MS-Has-Attach": "yes",
"X-MS-TNEF-Correlator": "",
"x-ms-exchange-messagesentrepresentingtype": "1",
"x-tmn": "[l/1bKlKzlZ0E7EbjcS9hwa/2cgrHB+/VlSZ7iyZk781u/HP4Jnoh9YgOyrgwIhqi]",
"x-ms-traffictypediagnostic": "TY3P286MB2723:EE_|TYVP286MB3117:EE_|CY4PEPF0000EE38:EE_|DM6PR14MB3821:EE_|DS0PR14MB6759:EE_",
"X-MS-Office365-Filtering-Correlation-Id": "c7b6508a-41fb-42f2-64e0-08dc4ac2c003",
"x-ms-exchange-slblob-mailprops": "vQx3cGk1+xyRxwYZil1vsotul+JhzeXjOetMehWWNQc3RBwDUMnxMyMQdXovrsbBYoN2ilpDRYa8EJmdvNygc9d+iQFfmttE/VEs+ZXSjO/MwuDUAtE6U598HgyVcDNsFvH2J+hFRm/M9GR/UEL1t0UIu6z6SWsHdN8TgbYY/C6yKdJUUYZFbDII9tA44eBoctrq2RxnGJOfHF/cj0LTHbfbdfbggvYScilDgqQnIdpYk0ATid2r3orVfRpssLeNOZs9E+lu1AfBz+RA+Q4Mvdaxo6FNLqum7V1FQ0KlisRCHwup0c3Mzo+gcT2NF29JmgLHxJTl1F5kwglKSaF/CECZGmSjANB6dYn5oXxvVD6llBR4+uRQKAJq7LPCzSIiBExqlcW44Tzax4/u3FFYB8Jl4vlvQBfvpEVUItVbsCj/1UueHEcSoFIjKI+/jymWUFZFxNhd03hPR+mZDS9Yo0XYWFk4r2pD16JwjrxLURQknhVQxCMi5ZUsmQNSq7B8ch+iMI3Qij3WEliUDGYz5B5ZG1ml96tPozMoLriT+yX9W7OSt165CMHOG/Ieodk/okOCpJ9DU/J06xydLKc6jFcQxqCVXK5ocadafbXtuCo=",
"X-Microsoft-Antispam-Untrusted": "BCL:0;",
"X-Microsoft-Antispam-Message-Info-Original": "WJhbZQS//9SLbKoUNFTVyepPwz5uiIVDkkWoJgOXtJj24Og/4MniQA8ZtaRIMh7cSWdcWvMq/KxY3cLO/R0j3MKrpQtAe8mLgb3Q0+pt5gF1hafS0sz6c+lIRjUqFF2JrwBLJupwy/FtnhBB3C+THuv1uG3OPEjIt1yOkpuHtFrhRQz5T6iDwwDzZYumH/bUhoPZoWzQ2tKLXJqPj0eiyW1Lp8Sdra3vQXd/93VED4cYy/7SLHNpw6Bp8H6PTbCyfuTPPEMMsz417pQsX744kL35fEwSHPsVZYArsnBgFuo8BDyq5c1mixC9hCisAttjpBVdOxDq/yDssriZthFJ7rNl1eOsx1VfrDeEq+UNMCcWCXaNLGr1ZM4T7p2BpYYikXgssEvIk/i6+hfr9vhmQNAmwWvJqx6XHd6UeOvHmg7x8oJjuaj9IA9PxvChxiIewidRWTuaAfpqJhVC/R3ipwWjyLDxrxFhb+jHRGcoiD/hWZpV0U4Yt4nf+HsayTlcdFDmqLQOsnfrXaCJLAPPCrJDwqwAumQgPPdG8p+TOKOxd1rtfGKmZa9Z3HSedmsS6pWU6XgPSVWA8R++2muzrycQ6k/4fp0HSNurI20/IpWwQudZUa9hOxjxzJoAjqAQ/uRb1kG0JfWTdl5AmC3nutlPy25zK+zr3pvicwvcCYQ=",
"X-MS-Exchange-AntiSpam-MessageData-Original-ChunkCount": "1",
"X-MS-Exchange-AntiSpam-MessageData-Original-0": "TbEsuTxprCNx7VztYnj6L5JwTs3JG7TjZ520Vm77MRkVCIvgUwK5WVzu4XUwmulHeQSSsDdt74KwaDY1Nn9F4C8MF/B/v0MtA3QIKPIhIZwO0Y+u8NVrb/A03fpIhCKiU6DvPZXos0kb5ZydFwgwc5GP+WrRcEtmsMFpgpIVkqdJqBDwcqzf0Qac5cy0ojn9K6PzW2RhGTGTYdh8M/86azL/dHwUa+QKLDH35OjtkcDYTwKETWzQaZK5skNLZl/D+clx0qsB1AYEm2i23s5lV4WSonwjV3+bksjmg5YEQDZDrrI6c789IJYL0LO6BB8OYPA1FMkpLnW3vv6YH48UpphjrOJo3KoYnl1vi8Hrb+ZR3NblFfgDNE6a+OoluTLg/kL24dsNSxP0mDDkd1selUlDUmASDkrzgOvF9T4VwUirtTlLbxVVCZWGHeQjL71BC8zW6AG0lcX5yyf/8nFp2YzTJxg78I1PUr3bLF7L9JD3BNfCCYWJUexGAF7HNl3mRRkLjC8ksBqbbEleQSNKSS/86QkOu0EbWJLkL/RYhseO61OlrOpi4p2k2NDwW/2tgqaV8QAg7W++mdxDmwe21a6fWAA36vIMwPJxzkDsNL8/0wEvlr77PKtYZ23wamBvLJZpYM7zWasmimLHu93curq2tKne9Xvob/IpRodeke9AXaPDmZUeV4nyEb2ur9Gj5tggIsv1/I/qAakPzzFtBKmyRZ/jWBeOQIUarVViEJEPaCH8VuJk2M664uwbIsdhZixBMd93FB7BpuIMVQtylBhb9VxwEa0Yuiq1uUd/cv5sqL6wZtBcKXiF1jRirkfShNO+gC31Q6ne0Gl+1dem6jXGk85fz7X2ZcpTMgd3Cv06wY9Qly4lLyLJETSs8Zk0ry/1s0GfrweD/AZEsufFGJv8aTjW3P5kAsFypVKdqSuaFZPFBJ+agsvUjqRuPKu4UNCimLJ+R/Kj3YxY22mza465+zw1K9/LC9H5ked+J17zDTp/fDEHyJD1m4HIwDOvTBNl/SN51/2Q5Jx1yPY0nkubfHpAVOSnIDaHfoQt0rbW67wesFy+cp6YK1YW8ZNt72yPYelCu8PorX2PGeEiscnQS2mL4iOEIQ5jNEJcX7Vz3JbqWaIsr64EiuvO/Ce0mZJuFrLhTG0kMb+L0DI7RhUiKSsb1q2OMNawWtb1m9z5B/5fSFoETsgX0FYXdZcQq0EtwPkJJrDW8mn3fNiZM+f1yvzLFNenUSRoAII0rSUBTkj1Q/Q47SaASEQS++7z6kSRgKsk+6VUuWIo2m5eFdwvbs0ZFI74iY3ekWdYc2UV4521u4u3rdkwB/YUcONQ3MrwuBVLS+YojdadDc+VPQ==",
"X-MS-Exchange-Transport-CrossTenantHeadersStamped": "DM6PR14MB3821",
"Return-Path": "maheshkumaar.balaji@outlook.com",
"X-MS-Exchange-Organization-ExpirationStartTime": "22 Mar 2024 22:52:28.5326(UTC)",
"X-MS-Exchange-Organization-ExpirationStartTimeReason": "OriginalSubmit",
"X-MS-Exchange-Organization-ExpirationInterval": "1:00:00:00.0000000",
"X-MS-Exchange-Organization-ExpirationIntervalReason": "OriginalSubmit",
"X-MS-Exchange-Organization-Network-Message-Id": "c7b6508a-41fb-42f2-64e0-08dc4ac2c003",
"X-EOPAttributedMessage": "0",
"X-EOPTenantAttributedMessage": "c09486f1-4e60-48d9-a3ca-1af438ae8849:0",
"X-MS-Exchange-Organization-MessageDirectionality": "Incoming",
"X-MS-Exchange-Transport-CrossTenantHeadersStripped": "CY4PEPF0000EE38.namprd03.prod.outlook.com",
"X-MS-Exchange-Transport-CrossTenantHeadersPromoted": "CY4PEPF0000EE38.namprd03.prod.outlook.com",
"X-MS-PublicTrafficType": "Email",
"X-MS-Exchange-Organization-AuthSource": "CY4PEPF0000EE38.namprd03.prod.outlook.com",
"X-MS-Exchange-Organization-AuthAs": "Anonymous",
"X-MS-Office365-Filtering-Correlation-Id-Prvs": "5468b413-76b6-41ff-6b43-08dc4ac2bdc0",
"X-MS-Exchange-Organization-SCL": "-1",
"X-Microsoft-Antispam": "BCL:0;",
"X-Forefront-Antispam-Report": "CIP:52.103.66.3;CTRY:JP;LANG:en;SCL:-1;SRV:;IPV:NLI;SFV:SFE;H:OS0P286CU011.outbound.protection.outlook.com;PTR:mail-japanwestazolkn19011003.outbound.protection.outlook.com;CAT:NONE;SFS:(13230031);DIR:INB;",
"X-MS-Exchange-CrossTenant-OriginalArrivalTime": "22 Mar 2024 22:52:28.2201(UTC)",
"X-MS-Exchange-CrossTenant-Network-Message-Id": "c7b6508a-41fb-42f2-64e0-08dc4ac2c003",
"X-MS-Exchange-CrossTenant-Id": "c09486f1-4e60-48d9-a3ca-1af438ae8849",
"X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg": "00000000-0000-0000-0000-000000000000",
"X-MS-Exchange-CrossTenant-rms-persistedconsumerorg": "00000000-0000-0000-0000-000000000000",
"X-MS-Exchange-CrossTenant-AuthSource": "CY4PEPF0000EE38.namprd03.prod.outlook.com",
"X-MS-Exchange-CrossTenant-AuthAs": "Anonymous",
"X-MS-Exchange-CrossTenant-FromEntityHeader": "Internet",
"X-MS-Exchange-Transport-EndToEndLatency": "00:00:09.0388826",
"X-MS-Exchange-Processed-By-BccFoldering": "15.20.7409.009",
"X-Microsoft-Antispam-Mailbox-Delivery": "wl:1;pcwl:1;ucf:0;jmr:0;auth:0;dest:I;ENG:(910001)(944506478)(944626604)(920097)(811239)(255002)(410001)(930097)(140003);",
"X-Microsoft-Antispam-Message-Info": "sk7bTTPTfs+DIAFkVCwxr5/5fLcpTVkL0qf0Bi+NaaGSZLw4SZ/bmh+l9chV1hfaIpbN/HHfSg2ZJMV6U5Ix603saZ8hgmkiykS1Kne/mqhg5+Z9SPU+mdREEHqrJpwh23riSba+xIkSqbhL80DeHTdasAnTX8Dof+lG9U5IGQWIpH6kKONTU2OrdstdQ42KFyM7E2AODrKkUm74DIsv/EyvCDvvByu0mv5Gxq/CSV34bccvtJ6hAgiaD26MucWCT9KlXFx4T6pON/tG+TeA1qQ4MPvD9e+4S1/LAqgx9Kmj5eMEZj0EkNNNlC1qvY0XHZfgI950L+ODvW4FAKjbZNv9Wzgo2ObVcnfkMJ4PpGDux6TySKlNCjX4Vuul2Ei2/wIUhLMdSa25HnKbtjDz6SHjnhU5X+sVFrvSCNu7LQkDvUVomMd73eJp/S1sP+SqFrlqRTyq1MqOp9I2jFA4/EDleavryeWU9fZooT3L+vhOlf217nxTqp89b3y7ddD1W3FT/u+oagRF0hr8a304wDx2bxNrJ1HFjOW11ISlpi6/h+pRNkQkg0d39fy8ySMZeZ0f9qISKjcEdy8wxuBolYw+nNLjn/GxD2F4gPrsNq5Hk3Yv4YdVj9ZsMHL4ovtLRDS5R9oYC9UnvLQGF9M4k20I2ThQHQd5CKKM3S71JsAyog9Iw9fZjUqX5R3JQt6rm0bgMnr6++YYDUCGVDn//n5ABXeenMwMkLwt/wSXSfyG7Pr9i2YdGK23lm599VwyBZpkncdaVyvt8ytTjTh0fja5AIZZN+OnhgTtPHn8gPyjp9bMxRDnWaRrSwm68B89SpwyJahwgbnAA7LVuQdzHiHiknXJj6Y5zfsYH2M1D+zjGSlG4VKp9FtX0UPU0v+Nd3AHqlZ+74/BkMulJyAdHeSbltrwTmIMsXuVUDLu9d6/GejtZDQF+7fRSKZ3HpBv7BuXUNivS2wjsmLEChqcqKcakUovv/LRy0LvmoEQfeaIUBStK3oIA7xj6YVEZP00AvwAql2dNDJR+cmNF+QKtl0l+Ya6yhN7K2kqjOD1rTLCnpkgV+IwcTQT8J1S+66vw0FaxLAYQ783po80brQFQZ9Kjb/COeQhw+FoEtW+2RxsRR+qF9bPEx6pbyL6Sb95POOBVD1k5zN/YU0up1SxRN7qQbEIfrSBRgj1A0Fg8Wsq0mp7JUqc7at9hGQfT6wc6KFY1k944zObpfdgGlvHGjXlMi4Xy53Sx9GOzIozBZ4pJYyBQOjKLhxZ7KU4+ISBgA+sGJkShlAkDSI8HhHQTWKE6GOT1oSR/7w93q6nnRT8XUj0u82+2tivgwuIYV7XjNYqNmTi3wlKlu08Aw9+ubI5fepHhrgkd8NCk/5cM1+aTpGi27ywBicYnqsE4cj7Zrn460R/mq6LPtdXRIFCyJ9LRWqI2Se5l6spGtmH5PQLwMlOcTGVBs0Nf1FxT62toD7hJfZgToICylTLccGx+40EuwAYaX5/7alPxtzZ1srSCpTiDDUeKJdx0b7mt3791RSpDWiaWSDiGntUXkojhoc/QTEDQktJhwo/MNWksOp3zhgM4t4cOEFTDsci3VxN2apVd0qxEEHXt+KhB5kovoSFVPqLcnE4EqwyrCQA1nXeSJzc1umLm87yXkUmcDfIyHDKrkyr51rOAs+dsONqd5GlLGj8ibYhcuY9iQyUfqlWeliImzKTAjbVG4vncWfu02F+1mqfESgBfD13V93Dt5ZWb3R1cnzd1b9tdlUf3x6fhvgsd+iYQyq6x7V02x4eKBB44LdJHbIp6OP+tKfmY/rjO4J9CmnzyQr7PoPBuQSyFd0+CnvAen1bkWaPJwV2J+v/Em/3Yy713Wg7MCC63Q=="
},
"Content-Type": "multipart/mixed; charset=us-ascii",
"To": "Mahesh Kumaar Balaji <maheshkumaar.balaji@mkbdgs.com>",
"Cc": "",
"Bcc": "",
"Reply-To": "",
"Attachment-Count": 1
}
```
## Modules Used
Given below are the list of all the modules used in the *EMLMailReader* library.
- **os** - To perform operating system file path manipulations.
- **logging** - To generate logs for EML file processing.
- **quopri** - To decode quoted-printable encoded string.
- **base64** - To decode base64 encoded string.
- **json** - To convert a python object to JSON and vice versa.
All modules mentioned above are present in the Standard Python library and thus, do not require explicit installation or configuration.
## Documentation
This section showcases the key classes employed in the library for handling an EML file and storing the information extracted from it.
| **Class Name** | **Purpose in library** |
|-------------------------------------------|----------------------------------------------------------------------------------------------------|
| [MailReader](#mailreader) | Processes an EML file, and returns the extracted information as an object of type *RxMailMessage*. |
| [RxMailMessage](#rxmailmessage) | A container to store and process information parsed from the EML file. |
| [TextEncoding](#textencoding) | Exposes methods to decode header strings and MIME part body in the EML file. |
| [MailAttachment](#mailattachment) | Exposes properties and methods to represent a single mail attachment from the EML file. |
| [MailAddress](#mailaddress) | A class to represent an email address. |
| [ContentType](#contenttype) | A class to represent the Content-Type header of a MIME entity. |
| [ContentDisposition](#contentdisposition) | A class to represent the Content-Disposition header of a MIME entity. |
| [Logger](#logger) | A class to manage the configuration and generation of logs during EML file processing. |
This section also elaborates other custom entities exposed by the library.
| **Name** | **Purpose in library** |
|---------------------------------------------|--------------------------------------------------------------------------|
| [Custom Enumerations](#custom-enumerations) | Enumerations to record different options available for processing. |
| [Custom Exceptions](#custom-exceptions) | Exceptions to report error scenarios that might occur during processing. |
| [Custom Collections](#custom-collections) | Collections to hold a list of items of a composite type. |
### MailReader
Exposes a single instance method, to process an EML file and return all the information extracted (headers, email body and attachments) as an RxMailMessage object.
#### Instance Method(s)
| **Method** | **Parameter(s)** | **Return(s)** |
|------------|--------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|
| get_email | emlPath [string] - The complete file path where the EML file is located. | a RxMailMessage object in case of successful parsing, 'NoneType' in case of any errors. |
### RxMailMessage
A class to represent all the information extracted from an EML file.
#### Properties
| **Property** | **Type** | **Purpose** |
|-------------------------|--------------------------|--------------------------------------------------------------------|
| From | MailAddress | Email address in the 'From' header of EML file. |
| To | MailAddressCollection | A list of all the emails present in 'To' header of EML file. |
| Cc | MailAddressCollection | A list of all the emails present in 'Cc' header of EML file. |
| Bcc | MailAddressCollection | A list of all the emails present in 'Bcc' header of EML file. |
| ReplyTo | MailAddressCollection | A list of all the emails present in 'Reply-To' header of EML file. |
| Subject | string | Subject of the email |
| Body | string | Body of the email |
| ContentType | ContentType | Value in the 'Content-Type' header of EML file. |
| ContentDisposition | ContentDisposition | Value in the 'Content-Disposition' header of EML file. |
| ContentTransferEncoding | TransferEncoding | Value in the 'Content-Transfer-Encoding' header of EML file. |
| Headers | dictionary | A dictionary value containing all other headers. |
| MessageID | string | 'Message-ID' header value. |
| MimeVersion | string | 'MIME-Version' header value. |
| ContentID | string | 'Content-ID' header value. |
| Attachments | MailAttachmentCollection | List of all the attachments present in the EML file. |
#### Instance Method(s)
| **Method** | **Parameter(s)** | **Return(s)** |
|------------------|------------------------------------------------------------------------------|----------------------------------------------------------------------|
| export_as_json | No parameters needed | a JSON string containing all the fields of the RxMailMessage object. |
| save_attachments | TargetFolderPath [string] - Folder where the attachments will be downloaded. | does not return a value |
### TextEncoding
A class to perform character encoding - BASE64 and QUOTED-PRINTABLE on MIME part content. It uses the 'quopri' and 'base64' modules in the Standard Python library to decode the encoded strings.
#### Static Method(s)
| **Method** | **Parameter(s)** | **Return(s)** |
|--------------------|------------------------------------------------------------------------|---------------------------------------|
| decode_header | encoded_string [string] - The encoded MIME header value to be decoded. | the decoded string. |
| decode_base64_file | file_contents [string] - The file contents encoded as a base64 string. | The decoded file contents as 'bytes'. |
### MailAttachment
A class to represent an attachment present in the EML file.
#### Properties
| **Property** | **Type** | **Purpose** |
|--------------------|--------------------|--------------------------------------------------------|
| Name | string | Gets/Sets the name of the attachment. |
| ContentType | ContentType | Gets/Sets the "Content-Type" of the attachment. |
| ContentDisposition | ContentDisposition | Gets/Sets the "Content-Disposition" of the attachment. |
| Contents | bytes | Gets/Sets the contents of the attachment. |
| ContentID | string | Gets/Sets the "Content-ID" of the attachment. |
#### Instance Method(s)
| **Method** | **Parameter(s)** | **Return(s)** |
|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
| parse_values | contents [bytes] - Contents of the MailAttachment.<br>content_type [ContentType] - Content-Type of the attachment.<br>content_disposition [ContentDisposition] - Content-Disposition of the attachment.<br>content_id [string] - Content-ID of the attachment. | does not return a value. |
### MailAddress
A class to represent an email address.
#### Properties
| **Property** | **Type** | **Purpose** |
|--------------|----------|-------------------------------------------------|
| DisplayName | string | Gets/Sets the display name of the mail address. |
| Email | string | Gets/Sets the email part of the mail address. |
#### Instance Method(s)
| **Method** | **Parameter(s)** | **Return(s)** |
|------------|---------------------------------------------------------------------------------|--------------------------|
| parse | MailAddressString [string] - The string to be parsed into a MailAddress object. | does not return a value. |
### ContentType
A class to represent the Content-Type header of a MIME entity.
#### Properties
| **Property** | **Type** | **Purpose** |
|--------------|----------|-----------------------------------------------|
| MediaType | string | Media type and sub-type of the MIME entity. |
| Charset | string | Character set of the MIME entity. |
| Boundary | string | Boundary value for 'multipart' MIME entities. |
| Name | string | Name of the MIME entity. |
#### Instance Method(s)
| **Method** | **Parameter(s)** | **Return(s)** |
|------------|---------------------------------------------------------------------------------|--------------------------|
| parse | ContentTypeString [string] - The string to be parsed into a ContentType object. | does not return a value. |
### ContentDisposition
A class to represent the Content-Disposition header of a MIME entity.
#### Properties
| **Property** | **Type** | **Purpose** |
|------------------|-----------------|----------------------------------------------|
| DispositionType | DispositionType | Disposition type of the MIME entity. |
| FileName | string | File name of the MIME entity. |
| CreationDate | string | Date when the MIME entity was created. |
| ModificationDate | string | Date when the MIME entity was last modified. |
| Size | integer | Size of the MIME entity. |
#### Instance Method(s)
| **Method** | **Parameter(s)** | **Return(s)** |
|------------|-----------------------------------------------------------------------------------------------|--------------------------|
| parse | ContentDispositionString [string] - The string to be parsed into a ContentDisposition object. | does not return a value. |
### Logger
A class to manage the configuration and generation of logs during EML file processing.
#### Static Method(s)
| **Method** | **Parameter(s)** | **Return(s)** |
|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|
| set_configuration | logging_mode [LoggingMode] - Denotes where the generated logs have to be stored or printed.<br>target_folder [string] - The target folder where the log file must be created. If the 'logging_mode' is 'LoggingMode.CONSOLE', an empty string is returned. | the complete path to the log file generated. |
| log_entry | message [string] - message to be logged<br>logging_level [LoggingLevel] - Type of message being logged. | does not return a value |
### Custom Enumerations
Given below are the custom enumerations exposed by the library.
#### TransferEncoding
Enumeration to represent the different content encoding methods supported.
| **Name** | **Value** |
|------------------|-----------|
| BASE64 | 1 |
| SEVEN_BIT | 2 |
| EIGHT_BIT | 3 |
| QUOTED_PRINTABLE | 4 |
#### EntityType
Enumeration to represent the different MIME entity types supported.
| **Name** | **Value** |
|------------|-----------|
| ATTACHMENT | 1 |
| TEXT | 2 |
| MIME_PART | 3 |
#### DispositionType
Enumeration to represent the different content disposition types supported in MIME.
| **Name** | **Value** |
|------------|-----------|
| ATTACHMENT | 1 |
| INLINE | 2 |
#### LoggingLevel
Enumeration containing the different levels of logging available for a module.
| **Name** | **Value** |
|----------|-----------|
| DEBUG | 1 |
| INFO | 2 |
| ERROR | 3 |
| CRITICAL | 4 |
#### LoggingMode
Enumeration containing the different modes of logging available for a module.
| **Name** | **Value** |
|----------|-----------|
| CONSOLE | 1 |
| FILE | 2 |
| NONE | 3 |
### Custom Exceptions
Given below are the list of custom exceptions exposed by the library.
| **Exception** | **Purpose** |
|-------------------------|---------------------------------------------------------------------------|
| InvalidEncodingError | To report Invalid Encoding errors. |
| FileMissingError | To report when file is missing at the specified location. |
| IncompleteHeaderError | To report when an incomplete header line is found in the EML file. |
| FolderNotAvailableError | To report when a given folder is not available at the specified location. |
### Custom Collections
The library exposes the following custom collection classes.
| **Collection** | **Purpose** |
|--------------------------|------------------------------------------------------------|
| MailAddressCollection | A Collection to hold a list of MailAddress instance(s). |
| MailAttachmentCollection | A Collection to hold a list of MailAttachment instance(s). |
#### Instance Method(s)
| **Method** | **Parameter(s)** | **Return(s)** |
|----------------|---------------------------------------------------------------------------------------------|--------------------------------------------|
| append | item[MailAddress or MailAttachment] - the item to be appended to the end of the collection. | does not return a value. |
| length | no parameter(s). | number of items in the collection. |
| export_as_list | no parameter(s). | the items in the collection as a new list. |
Raw data
{
"_id": null,
"home_page": null,
"name": "emlmailreader",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "email, reader, eml, parser",
"author": null,
"author_email": "Mahesh Kumaar Balaji <maheshkumaar.balaji@outlook.com>",
"download_url": "https://files.pythonhosted.org/packages/c1/b1/96a416fc892e2e5dcc0b3b93e55be7bfb0912d9850e7a17709e9961c508d/emlmailreader-1.0.1.tar.gz",
"platform": null,
"description": "# EMLMailReader\n\nThis Python library streamlines the process of working with EML files. Effortlessly extract crucial details like sender and recipient information, subject lines, email bodies, and a complete list of headers. For in-depth analysis, export the parsed data in the widely-used JSON format. Additionally, the library provides the convenience of downloading any associated attachments directly to your local machine for further processing.\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Example Usage](#example-usage)\n- [Modules Used](#modules-used)\n- [Documentation](#documentation)\n\n## Installation\n\nTo install the library locally, make sure you have *python* and *pip* installed in your system, and then run the below command.\n\n```\npip install emlmailreader\n```\n\n## Example Usage\n\nHere's a sample code to leverage **EMLMailReader** in parsing an EML file and extract information contained within.\n\n```\nfrom EMLMailReader import MailReader, RxMailMessage\n \nreader: MailReader = MailReader()\nmessage = reader.get_email(\"COMPLETE_EML_FILE_PATH\")\nif isinstance(message, RxMailMessage):\n json_string = message.export_as_json()\n print(json_string)\n```\n\nIn this context, the term \"COMPLETE_EML_FILE_PATH\" indicates the complete path of the .EML file intended for processing. Running this code will output a JSON string resembling the one provided below.\n\n```\n{\n \"From\": \"Mahesh Kumaar Balaji <maheshkumaar.balaji@outlook.com>\",\n \"Subject\": \"Test-Email-5\",\n \"Message-ID\": \"<TY3P286MB27238431EA4EE3F05821CDD7E4312@TY3P286MB2723.JPNP286.PROD.OUTLOOK.COM>\",\n \"IsMultiPart\": true,\n \"Mime-Version\": \"1.0\",\n \"Date\": \"Fri, 22 Mar 2024 22:52:24 +0000\",\n \"Headers\": {\n \"Received\": \"from TY3P286MB2723.JPNP286.PROD.OUTLOOK.COM([fe80::9b2e:a11f:e0f1:779c]) by TY3P286MB2723.JPNP286.PROD.OUTLOOK.COM([fe80::9b2e:a11f:e0f1:779c%4]) with mapi id 15.20.7409.023; Fri, 22 Mar 202422:52:24 +0000\",\n \"ARC-Seal\": \"i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none;b=R7Ad8lvJlkvb3ov//iWvUp0UNJBNSuPikhA9JmxzD+mzmKSZBG2O9N6DS3zgrY3FuysknY3gVzCwODU1D5toiiJDJrWOGACizAmxZ6PwB3oCyA6BOGS3c4XIoO9PoN5iibHVgaDYFB+ktslKH0ydWevOFfPH7IQ9jj4yh8hJRm3HlostxLmYufsWtVm6VV16AN222F/31GnJn+ka8Xw5HiEeTooZw1xApc8FF+2ZFgpQWXwQF188LxgPawMRWtsrAxlcGfQ0lZKvOH2xNbyMOwKDwYRiOfjCtIO9jmuhlU+dFOXm5Xsanu9R9WSe8r/s40EU+ym78ZF+id59f4SKfg==\",\n \"ARC-Message-Signature\": \"i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com;s=arcselector9901;h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1;bh=GZNu+uY4tmf+Dg5UG62PQ4Lx0mkpwlqJV6YZapikb3Y=;b=BPZcx+/mDa/IsQohNF/q8w/Bwdf/xOyrOetQAAgq8WbY8I/0pwd4yuCdEyR5yOShyEyiQZYQdTCLGSXUO6e4ALY7/eu2XUyY6BOmbk7piCMkfWHDCh0dr0dbVHLHV7aAOm+FrNY+id5+6FTu8oTwFLF2gOS5Zdm92VYUgOWJseyZBslgVZGI6lLrgX3zyvEO5YdsZW1rUDuoK1m7h6sZcaYWGdhaZmOZxhGADLQjGKiSxuqXa6gj219qiOshbuYAwUbBrZUlwe//M0wqU7qMpD5HFRZGTnrtFHALX5TW6Aak584tV7SctKIclQNcqiyPXZkPEwYcx35v9EZmBlO/Xg==\",\n \"ARC-Authentication-Results\": \"i=1; mx.microsoft.com 1; spf=none; dmarc=none;dkim=none; arc=none\",\n \"Authentication-Results\": \"spf=pass (sender IP is 52.103.66.3)smtp.mailfrom=outlook.com; dkim=pass (signature was verified)header.d=outlook.com;dmarc=pass action=noneheader.from=outlook.com;compauth=pass reason=100\",\n \"Received-SPF\": \"Pass (protection.outlook.com: domain of outlook.com designates52.103.66.3 as permitted sender) receiver=protection.outlook.com;client-ip=52.103.66.3; helo=OS0P286CU011.outbound.protection.outlook.com;pr=C\",\n \"DKIM-Signature\": \"v=1; a=rsa-sha256; c=relaxed/relaxed; d=outlook.com;s=selector1;h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck;bh=GZNu+uY4tmf+Dg5UG62PQ4Lx0mkpwlqJV6YZapikb3Y=;b=bdqw84toCecsyc1+gQcqkfjw0blT4jfKHQMqmrRiVodhnIU9OcGUzYxsjPjB0w8scHu89+AL12fp4/a/7uLPI9HfoV+VQfWLfkPAJIjrq4dB/RC/pTrXvX7W1ROmQt1Toj5SRss1fXQHYjONBaAOmmHrNstjB3g9gIumNor+fussHVY7lhrj37bg1EjGUrQL5PQ1o4y+29U6Q4UMI3V+ESNgbyRMfqW8BXAaCy6iDHOZuFWS1562hjtDTYHqN9cx+e4X3sY+Z2q+ac3TvxDt5fjbd8ji/hNzAPgIW6ml4XZExyVdWZdNvfY95yvitpO7mfdOAAH8ac5XrYEDJEP/5A==\",\n \"Thread-Topic\": \"Test-Email-5\",\n \"Thread-Index\": \"AQHafKt91GiqauDZ2k6oNt2I9lOJUQ==\",\n \"Accept-Language\": \"en-US\",\n \"Content-Language\": \"en-US\",\n \"X-MS-Has-Attach\": \"yes\",\n \"X-MS-TNEF-Correlator\": \"\",\n \"x-ms-exchange-messagesentrepresentingtype\": \"1\",\n \"x-tmn\": \"[l/1bKlKzlZ0E7EbjcS9hwa/2cgrHB+/VlSZ7iyZk781u/HP4Jnoh9YgOyrgwIhqi]\",\n \"x-ms-traffictypediagnostic\": \"TY3P286MB2723:EE_|TYVP286MB3117:EE_|CY4PEPF0000EE38:EE_|DM6PR14MB3821:EE_|DS0PR14MB6759:EE_\",\n \"X-MS-Office365-Filtering-Correlation-Id\": \"c7b6508a-41fb-42f2-64e0-08dc4ac2c003\",\n \"x-ms-exchange-slblob-mailprops\": \"vQx3cGk1+xyRxwYZil1vsotul+JhzeXjOetMehWWNQc3RBwDUMnxMyMQdXovrsbBYoN2ilpDRYa8EJmdvNygc9d+iQFfmttE/VEs+ZXSjO/MwuDUAtE6U598HgyVcDNsFvH2J+hFRm/M9GR/UEL1t0UIu6z6SWsHdN8TgbYY/C6yKdJUUYZFbDII9tA44eBoctrq2RxnGJOfHF/cj0LTHbfbdfbggvYScilDgqQnIdpYk0ATid2r3orVfRpssLeNOZs9E+lu1AfBz+RA+Q4Mvdaxo6FNLqum7V1FQ0KlisRCHwup0c3Mzo+gcT2NF29JmgLHxJTl1F5kwglKSaF/CECZGmSjANB6dYn5oXxvVD6llBR4+uRQKAJq7LPCzSIiBExqlcW44Tzax4/u3FFYB8Jl4vlvQBfvpEVUItVbsCj/1UueHEcSoFIjKI+/jymWUFZFxNhd03hPR+mZDS9Yo0XYWFk4r2pD16JwjrxLURQknhVQxCMi5ZUsmQNSq7B8ch+iMI3Qij3WEliUDGYz5B5ZG1ml96tPozMoLriT+yX9W7OSt165CMHOG/Ieodk/okOCpJ9DU/J06xydLKc6jFcQxqCVXK5ocadafbXtuCo=\",\n \"X-Microsoft-Antispam-Untrusted\": \"BCL:0;\",\n \"X-Microsoft-Antispam-Message-Info-Original\": \"WJhbZQS//9SLbKoUNFTVyepPwz5uiIVDkkWoJgOXtJj24Og/4MniQA8ZtaRIMh7cSWdcWvMq/KxY3cLO/R0j3MKrpQtAe8mLgb3Q0+pt5gF1hafS0sz6c+lIRjUqFF2JrwBLJupwy/FtnhBB3C+THuv1uG3OPEjIt1yOkpuHtFrhRQz5T6iDwwDzZYumH/bUhoPZoWzQ2tKLXJqPj0eiyW1Lp8Sdra3vQXd/93VED4cYy/7SLHNpw6Bp8H6PTbCyfuTPPEMMsz417pQsX744kL35fEwSHPsVZYArsnBgFuo8BDyq5c1mixC9hCisAttjpBVdOxDq/yDssriZthFJ7rNl1eOsx1VfrDeEq+UNMCcWCXaNLGr1ZM4T7p2BpYYikXgssEvIk/i6+hfr9vhmQNAmwWvJqx6XHd6UeOvHmg7x8oJjuaj9IA9PxvChxiIewidRWTuaAfpqJhVC/R3ipwWjyLDxrxFhb+jHRGcoiD/hWZpV0U4Yt4nf+HsayTlcdFDmqLQOsnfrXaCJLAPPCrJDwqwAumQgPPdG8p+TOKOxd1rtfGKmZa9Z3HSedmsS6pWU6XgPSVWA8R++2muzrycQ6k/4fp0HSNurI20/IpWwQudZUa9hOxjxzJoAjqAQ/uRb1kG0JfWTdl5AmC3nutlPy25zK+zr3pvicwvcCYQ=\",\n \"X-MS-Exchange-AntiSpam-MessageData-Original-ChunkCount\": \"1\",\n \"X-MS-Exchange-AntiSpam-MessageData-Original-0\": \"TbEsuTxprCNx7VztYnj6L5JwTs3JG7TjZ520Vm77MRkVCIvgUwK5WVzu4XUwmulHeQSSsDdt74KwaDY1Nn9F4C8MF/B/v0MtA3QIKPIhIZwO0Y+u8NVrb/A03fpIhCKiU6DvPZXos0kb5ZydFwgwc5GP+WrRcEtmsMFpgpIVkqdJqBDwcqzf0Qac5cy0ojn9K6PzW2RhGTGTYdh8M/86azL/dHwUa+QKLDH35OjtkcDYTwKETWzQaZK5skNLZl/D+clx0qsB1AYEm2i23s5lV4WSonwjV3+bksjmg5YEQDZDrrI6c789IJYL0LO6BB8OYPA1FMkpLnW3vv6YH48UpphjrOJo3KoYnl1vi8Hrb+ZR3NblFfgDNE6a+OoluTLg/kL24dsNSxP0mDDkd1selUlDUmASDkrzgOvF9T4VwUirtTlLbxVVCZWGHeQjL71BC8zW6AG0lcX5yyf/8nFp2YzTJxg78I1PUr3bLF7L9JD3BNfCCYWJUexGAF7HNl3mRRkLjC8ksBqbbEleQSNKSS/86QkOu0EbWJLkL/RYhseO61OlrOpi4p2k2NDwW/2tgqaV8QAg7W++mdxDmwe21a6fWAA36vIMwPJxzkDsNL8/0wEvlr77PKtYZ23wamBvLJZpYM7zWasmimLHu93curq2tKne9Xvob/IpRodeke9AXaPDmZUeV4nyEb2ur9Gj5tggIsv1/I/qAakPzzFtBKmyRZ/jWBeOQIUarVViEJEPaCH8VuJk2M664uwbIsdhZixBMd93FB7BpuIMVQtylBhb9VxwEa0Yuiq1uUd/cv5sqL6wZtBcKXiF1jRirkfShNO+gC31Q6ne0Gl+1dem6jXGk85fz7X2ZcpTMgd3Cv06wY9Qly4lLyLJETSs8Zk0ry/1s0GfrweD/AZEsufFGJv8aTjW3P5kAsFypVKdqSuaFZPFBJ+agsvUjqRuPKu4UNCimLJ+R/Kj3YxY22mza465+zw1K9/LC9H5ked+J17zDTp/fDEHyJD1m4HIwDOvTBNl/SN51/2Q5Jx1yPY0nkubfHpAVOSnIDaHfoQt0rbW67wesFy+cp6YK1YW8ZNt72yPYelCu8PorX2PGeEiscnQS2mL4iOEIQ5jNEJcX7Vz3JbqWaIsr64EiuvO/Ce0mZJuFrLhTG0kMb+L0DI7RhUiKSsb1q2OMNawWtb1m9z5B/5fSFoETsgX0FYXdZcQq0EtwPkJJrDW8mn3fNiZM+f1yvzLFNenUSRoAII0rSUBTkj1Q/Q47SaASEQS++7z6kSRgKsk+6VUuWIo2m5eFdwvbs0ZFI74iY3ekWdYc2UV4521u4u3rdkwB/YUcONQ3MrwuBVLS+YojdadDc+VPQ==\",\n \"X-MS-Exchange-Transport-CrossTenantHeadersStamped\": \"DM6PR14MB3821\",\n \"Return-Path\": \"maheshkumaar.balaji@outlook.com\",\n \"X-MS-Exchange-Organization-ExpirationStartTime\": \"22 Mar 2024 22:52:28.5326(UTC)\",\n \"X-MS-Exchange-Organization-ExpirationStartTimeReason\": \"OriginalSubmit\",\n \"X-MS-Exchange-Organization-ExpirationInterval\": \"1:00:00:00.0000000\",\n \"X-MS-Exchange-Organization-ExpirationIntervalReason\": \"OriginalSubmit\",\n \"X-MS-Exchange-Organization-Network-Message-Id\": \"c7b6508a-41fb-42f2-64e0-08dc4ac2c003\",\n \"X-EOPAttributedMessage\": \"0\",\n \"X-EOPTenantAttributedMessage\": \"c09486f1-4e60-48d9-a3ca-1af438ae8849:0\",\n \"X-MS-Exchange-Organization-MessageDirectionality\": \"Incoming\",\n \"X-MS-Exchange-Transport-CrossTenantHeadersStripped\": \"CY4PEPF0000EE38.namprd03.prod.outlook.com\",\n \"X-MS-Exchange-Transport-CrossTenantHeadersPromoted\": \"CY4PEPF0000EE38.namprd03.prod.outlook.com\",\n \"X-MS-PublicTrafficType\": \"Email\",\n \"X-MS-Exchange-Organization-AuthSource\": \"CY4PEPF0000EE38.namprd03.prod.outlook.com\",\n \"X-MS-Exchange-Organization-AuthAs\": \"Anonymous\",\n \"X-MS-Office365-Filtering-Correlation-Id-Prvs\": \"5468b413-76b6-41ff-6b43-08dc4ac2bdc0\",\n \"X-MS-Exchange-Organization-SCL\": \"-1\",\n \"X-Microsoft-Antispam\": \"BCL:0;\",\n \"X-Forefront-Antispam-Report\": \"CIP:52.103.66.3;CTRY:JP;LANG:en;SCL:-1;SRV:;IPV:NLI;SFV:SFE;H:OS0P286CU011.outbound.protection.outlook.com;PTR:mail-japanwestazolkn19011003.outbound.protection.outlook.com;CAT:NONE;SFS:(13230031);DIR:INB;\",\n \"X-MS-Exchange-CrossTenant-OriginalArrivalTime\": \"22 Mar 2024 22:52:28.2201(UTC)\",\n \"X-MS-Exchange-CrossTenant-Network-Message-Id\": \"c7b6508a-41fb-42f2-64e0-08dc4ac2c003\",\n \"X-MS-Exchange-CrossTenant-Id\": \"c09486f1-4e60-48d9-a3ca-1af438ae8849\",\n \"X-MS-Exchange-CrossTenant-RMS-PersistedConsumerOrg\": \"00000000-0000-0000-0000-000000000000\",\n \"X-MS-Exchange-CrossTenant-rms-persistedconsumerorg\": \"00000000-0000-0000-0000-000000000000\",\n \"X-MS-Exchange-CrossTenant-AuthSource\": \"CY4PEPF0000EE38.namprd03.prod.outlook.com\",\n \"X-MS-Exchange-CrossTenant-AuthAs\": \"Anonymous\",\n \"X-MS-Exchange-CrossTenant-FromEntityHeader\": \"Internet\",\n \"X-MS-Exchange-Transport-EndToEndLatency\": \"00:00:09.0388826\",\n \"X-MS-Exchange-Processed-By-BccFoldering\": \"15.20.7409.009\",\n \"X-Microsoft-Antispam-Mailbox-Delivery\": \"wl:1;pcwl:1;ucf:0;jmr:0;auth:0;dest:I;ENG:(910001)(944506478)(944626604)(920097)(811239)(255002)(410001)(930097)(140003);\",\n \"X-Microsoft-Antispam-Message-Info\": \"sk7bTTPTfs+DIAFkVCwxr5/5fLcpTVkL0qf0Bi+NaaGSZLw4SZ/bmh+l9chV1hfaIpbN/HHfSg2ZJMV6U5Ix603saZ8hgmkiykS1Kne/mqhg5+Z9SPU+mdREEHqrJpwh23riSba+xIkSqbhL80DeHTdasAnTX8Dof+lG9U5IGQWIpH6kKONTU2OrdstdQ42KFyM7E2AODrKkUm74DIsv/EyvCDvvByu0mv5Gxq/CSV34bccvtJ6hAgiaD26MucWCT9KlXFx4T6pON/tG+TeA1qQ4MPvD9e+4S1/LAqgx9Kmj5eMEZj0EkNNNlC1qvY0XHZfgI950L+ODvW4FAKjbZNv9Wzgo2ObVcnfkMJ4PpGDux6TySKlNCjX4Vuul2Ei2/wIUhLMdSa25HnKbtjDz6SHjnhU5X+sVFrvSCNu7LQkDvUVomMd73eJp/S1sP+SqFrlqRTyq1MqOp9I2jFA4/EDleavryeWU9fZooT3L+vhOlf217nxTqp89b3y7ddD1W3FT/u+oagRF0hr8a304wDx2bxNrJ1HFjOW11ISlpi6/h+pRNkQkg0d39fy8ySMZeZ0f9qISKjcEdy8wxuBolYw+nNLjn/GxD2F4gPrsNq5Hk3Yv4YdVj9ZsMHL4ovtLRDS5R9oYC9UnvLQGF9M4k20I2ThQHQd5CKKM3S71JsAyog9Iw9fZjUqX5R3JQt6rm0bgMnr6++YYDUCGVDn//n5ABXeenMwMkLwt/wSXSfyG7Pr9i2YdGK23lm599VwyBZpkncdaVyvt8ytTjTh0fja5AIZZN+OnhgTtPHn8gPyjp9bMxRDnWaRrSwm68B89SpwyJahwgbnAA7LVuQdzHiHiknXJj6Y5zfsYH2M1D+zjGSlG4VKp9FtX0UPU0v+Nd3AHqlZ+74/BkMulJyAdHeSbltrwTmIMsXuVUDLu9d6/GejtZDQF+7fRSKZ3HpBv7BuXUNivS2wjsmLEChqcqKcakUovv/LRy0LvmoEQfeaIUBStK3oIA7xj6YVEZP00AvwAql2dNDJR+cmNF+QKtl0l+Ya6yhN7K2kqjOD1rTLCnpkgV+IwcTQT8J1S+66vw0FaxLAYQ783po80brQFQZ9Kjb/COeQhw+FoEtW+2RxsRR+qF9bPEx6pbyL6Sb95POOBVD1k5zN/YU0up1SxRN7qQbEIfrSBRgj1A0Fg8Wsq0mp7JUqc7at9hGQfT6wc6KFY1k944zObpfdgGlvHGjXlMi4Xy53Sx9GOzIozBZ4pJYyBQOjKLhxZ7KU4+ISBgA+sGJkShlAkDSI8HhHQTWKE6GOT1oSR/7w93q6nnRT8XUj0u82+2tivgwuIYV7XjNYqNmTi3wlKlu08Aw9+ubI5fepHhrgkd8NCk/5cM1+aTpGi27ywBicYnqsE4cj7Zrn460R/mq6LPtdXRIFCyJ9LRWqI2Se5l6spGtmH5PQLwMlOcTGVBs0Nf1FxT62toD7hJfZgToICylTLccGx+40EuwAYaX5/7alPxtzZ1srSCpTiDDUeKJdx0b7mt3791RSpDWiaWSDiGntUXkojhoc/QTEDQktJhwo/MNWksOp3zhgM4t4cOEFTDsci3VxN2apVd0qxEEHXt+KhB5kovoSFVPqLcnE4EqwyrCQA1nXeSJzc1umLm87yXkUmcDfIyHDKrkyr51rOAs+dsONqd5GlLGj8ibYhcuY9iQyUfqlWeliImzKTAjbVG4vncWfu02F+1mqfESgBfD13V93Dt5ZWb3R1cnzd1b9tdlUf3x6fhvgsd+iYQyq6x7V02x4eKBB44LdJHbIp6OP+tKfmY/rjO4J9CmnzyQr7PoPBuQSyFd0+CnvAen1bkWaPJwV2J+v/Em/3Yy713Wg7MCC63Q==\"\n },\n \"Content-Type\": \"multipart/mixed; charset=us-ascii\",\n \"To\": \"Mahesh Kumaar Balaji <maheshkumaar.balaji@mkbdgs.com>\",\n \"Cc\": \"\",\n \"Bcc\": \"\",\n \"Reply-To\": \"\",\n \"Attachment-Count\": 1\n}\n```\n\n## Modules Used\n\nGiven below are the list of all the modules used in the *EMLMailReader* library.\n\n- **os** - To perform operating system file path manipulations.\n- **logging** - To generate logs for EML file processing.\n- **quopri** - To decode quoted-printable encoded string.\n- **base64** - To decode base64 encoded string.\n- **json** - To convert a python object to JSON and vice versa.\n\nAll modules mentioned above are present in the Standard Python library and thus, do not require explicit installation or configuration.\n\n## Documentation\n\nThis section showcases the key classes employed in the library for handling an EML file and storing the information extracted from it.\n\n| **Class Name** | **Purpose in library** |\n|-------------------------------------------|----------------------------------------------------------------------------------------------------|\n| [MailReader](#mailreader) | Processes an EML file, and returns the extracted information as an object of type *RxMailMessage*. |\n| [RxMailMessage](#rxmailmessage) | A container to store and process information parsed from the EML file. |\n| [TextEncoding](#textencoding) | Exposes methods to decode header strings and MIME part body in the EML file. |\n| [MailAttachment](#mailattachment) | Exposes properties and methods to represent a single mail attachment from the EML file. |\n| [MailAddress](#mailaddress) | A class to represent an email address. |\n| [ContentType](#contenttype) | A class to represent the Content-Type header of a MIME entity. |\n| [ContentDisposition](#contentdisposition) | A class to represent the Content-Disposition header of a MIME entity. |\n| [Logger](#logger) | A class to manage the configuration and generation of logs during EML file processing. |\n\nThis section also elaborates other custom entities exposed by the library.\n\n| **Name** | **Purpose in library** |\n|---------------------------------------------|--------------------------------------------------------------------------|\n| [Custom Enumerations](#custom-enumerations) | Enumerations to record different options available for processing. |\n| [Custom Exceptions](#custom-exceptions) | Exceptions to report error scenarios that might occur during processing. |\n| [Custom Collections](#custom-collections) | Collections to hold a list of items of a composite type. |\n\n\n### MailReader\n\nExposes a single instance method, to process an EML file and return all the information extracted (headers, email body and attachments) as an RxMailMessage object.\n\n#### Instance Method(s)\n\n| **Method** | **Parameter(s)** | **Return(s)** |\n|------------|--------------------------------------------------------------------------|-----------------------------------------------------------------------------------------|\n| get_email | emlPath [string] - The complete file path where the EML file is located. | a RxMailMessage object in case of successful parsing, 'NoneType' in case of any errors. |\n\n### RxMailMessage\n\nA class to represent all the information extracted from an EML file.\n\n#### Properties\n\n| **Property** | **Type** | **Purpose** |\n|-------------------------|--------------------------|--------------------------------------------------------------------|\n| From | MailAddress | Email address in the 'From' header of EML file. |\n| To | MailAddressCollection | A list of all the emails present in 'To' header of EML file. |\n| Cc | MailAddressCollection | A list of all the emails present in 'Cc' header of EML file. |\n| Bcc | MailAddressCollection | A list of all the emails present in 'Bcc' header of EML file. |\n| ReplyTo | MailAddressCollection | A list of all the emails present in 'Reply-To' header of EML file. |\n| Subject | string | Subject of the email |\n| Body | string | Body of the email |\n| ContentType | ContentType | Value in the 'Content-Type' header of EML file. |\n| ContentDisposition | ContentDisposition | Value in the 'Content-Disposition' header of EML file. |\n| ContentTransferEncoding | TransferEncoding | Value in the 'Content-Transfer-Encoding' header of EML file. |\n| Headers | dictionary | A dictionary value containing all other headers. |\n| MessageID | string | 'Message-ID' header value. |\n| MimeVersion | string | 'MIME-Version' header value. |\n| ContentID | string | 'Content-ID' header value. |\n| Attachments | MailAttachmentCollection | List of all the attachments present in the EML file. |\n\n#### Instance Method(s)\n\n| **Method** | **Parameter(s)** | **Return(s)** |\n|------------------|------------------------------------------------------------------------------|----------------------------------------------------------------------|\n| export_as_json | No parameters needed | a JSON string containing all the fields of the RxMailMessage object. |\n| save_attachments | TargetFolderPath [string] - Folder where the attachments will be downloaded. | does not return a value |\n\n### TextEncoding\n\nA class to perform character encoding - BASE64 and QUOTED-PRINTABLE on MIME part content. It uses the 'quopri' and 'base64' modules in the Standard Python library to decode the encoded strings.\n\n#### Static Method(s)\n\n| **Method** | **Parameter(s)** | **Return(s)** |\n|--------------------|------------------------------------------------------------------------|---------------------------------------|\n| decode_header | encoded_string [string] - The encoded MIME header value to be decoded. | the decoded string. |\n| decode_base64_file | file_contents [string] - The file contents encoded as a base64 string. | The decoded file contents as 'bytes'. |\n\n### MailAttachment\n\nA class to represent an attachment present in the EML file.\n\n#### Properties\n\n| **Property** | **Type** | **Purpose** |\n|--------------------|--------------------|--------------------------------------------------------|\n| Name | string | Gets/Sets the name of the attachment. |\n| ContentType | ContentType | Gets/Sets the \"Content-Type\" of the attachment. |\n| ContentDisposition | ContentDisposition | Gets/Sets the \"Content-Disposition\" of the attachment. |\n| Contents | bytes | Gets/Sets the contents of the attachment. |\n| ContentID | string | Gets/Sets the \"Content-ID\" of the attachment. |\n\n#### Instance Method(s)\n\n| **Method** | **Parameter(s)** | **Return(s)** |\n|--------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|\n| parse_values | contents [bytes] - Contents of the MailAttachment.<br>content_type [ContentType] - Content-Type of the attachment.<br>content_disposition [ContentDisposition] - Content-Disposition of the attachment.<br>content_id [string] - Content-ID of the attachment. | does not return a value. |\n\n### MailAddress\n\nA class to represent an email address.\n\n#### Properties\n\n| **Property** | **Type** | **Purpose** |\n|--------------|----------|-------------------------------------------------|\n| DisplayName | string | Gets/Sets the display name of the mail address. |\n| Email | string | Gets/Sets the email part of the mail address. |\n\n#### Instance Method(s)\n\n| **Method** | **Parameter(s)** | **Return(s)** |\n|------------|---------------------------------------------------------------------------------|--------------------------|\n| parse | MailAddressString [string] - The string to be parsed into a MailAddress object. | does not return a value. |\n\n### ContentType\n\nA class to represent the Content-Type header of a MIME entity.\n \n#### Properties\n\n| **Property** | **Type** | **Purpose** |\n|--------------|----------|-----------------------------------------------|\n| MediaType | string | Media type and sub-type of the MIME entity. |\n| Charset | string | Character set of the MIME entity. |\n| Boundary | string | Boundary value for 'multipart' MIME entities. |\n| Name | string | Name of the MIME entity. |\n\n#### Instance Method(s)\n\n| **Method** | **Parameter(s)** | **Return(s)** |\n|------------|---------------------------------------------------------------------------------|--------------------------|\n| parse | ContentTypeString [string] - The string to be parsed into a ContentType object. | does not return a value. |\n\n### ContentDisposition\n\nA class to represent the Content-Disposition header of a MIME entity.\n\n#### Properties\n\n| **Property** | **Type** | **Purpose** |\n|------------------|-----------------|----------------------------------------------|\n| DispositionType | DispositionType | Disposition type of the MIME entity. |\n| FileName | string | File name of the MIME entity. |\n| CreationDate | string | Date when the MIME entity was created. |\n| ModificationDate | string | Date when the MIME entity was last modified. |\n| Size | integer | Size of the MIME entity. |\n\n#### Instance Method(s)\n\n| **Method** | **Parameter(s)** | **Return(s)** |\n|------------|-----------------------------------------------------------------------------------------------|--------------------------|\n| parse | ContentDispositionString [string] - The string to be parsed into a ContentDisposition object. | does not return a value. |\n\n### Logger\n\nA class to manage the configuration and generation of logs during EML file processing.\n\n#### Static Method(s)\n\n| **Method** | **Parameter(s)** | **Return(s)** |\n|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------|\n| set_configuration | logging_mode [LoggingMode] - Denotes where the generated logs have to be stored or printed.<br>target_folder [string] - The target folder where the log file must be created. If the 'logging_mode' is 'LoggingMode.CONSOLE', an empty string is returned. | the complete path to the log file generated. |\n| log_entry | message [string] - message to be logged<br>logging_level [LoggingLevel] - Type of message being logged. | does not return a value |\n\n\n### Custom Enumerations\n\nGiven below are the custom enumerations exposed by the library.\n\n#### TransferEncoding\n\nEnumeration to represent the different content encoding methods supported.\n\n| **Name** | **Value** |\n|------------------|-----------|\n| BASE64 | 1 |\n| SEVEN_BIT | 2 |\n| EIGHT_BIT | 3 |\n| QUOTED_PRINTABLE | 4 |\n\n#### EntityType\n\nEnumeration to represent the different MIME entity types supported.\n\n| **Name** | **Value** |\n|------------|-----------|\n| ATTACHMENT | 1 |\n| TEXT | 2 |\n| MIME_PART | 3 |\n\n#### DispositionType\n\nEnumeration to represent the different content disposition types supported in MIME.\n\n| **Name** | **Value** |\n|------------|-----------|\n| ATTACHMENT | 1 |\n| INLINE | 2 |\n\n#### LoggingLevel\n\nEnumeration containing the different levels of logging available for a module.\n\n| **Name** | **Value** |\n|----------|-----------|\n| DEBUG | 1 |\n| INFO | 2 |\n| ERROR | 3 |\n| CRITICAL | 4 |\n\n#### LoggingMode\n\nEnumeration containing the different modes of logging available for a module.\n\n| **Name** | **Value** |\n|----------|-----------|\n| CONSOLE | 1 |\n| FILE | 2 |\n| NONE | 3 |\n\n### Custom Exceptions\n\nGiven below are the list of custom exceptions exposed by the library.\n\n| **Exception** | **Purpose** |\n|-------------------------|---------------------------------------------------------------------------|\n| InvalidEncodingError | To report Invalid Encoding errors. |\n| FileMissingError | To report when file is missing at the specified location. |\n| IncompleteHeaderError | To report when an incomplete header line is found in the EML file. |\n| FolderNotAvailableError | To report when a given folder is not available at the specified location. |\n\n### Custom Collections\n\nThe library exposes the following custom collection classes.\n\n| **Collection** | **Purpose** |\n|--------------------------|------------------------------------------------------------|\n| MailAddressCollection | A Collection to hold a list of MailAddress instance(s). |\n| MailAttachmentCollection | A Collection to hold a list of MailAttachment instance(s). |\n\n#### Instance Method(s)\n\n| **Method** | **Parameter(s)** | **Return(s)** |\n|----------------|---------------------------------------------------------------------------------------------|--------------------------------------------|\n| append | item[MailAddress or MailAttachment] - the item to be appended to the end of the collection. | does not return a value. |\n| length | no parameter(s). | number of items in the collection. |\n| export_as_list | no parameter(s). | the items in the collection as a new list. |\n",
"bugtrack_url": null,
"license": "Copyright (c) 2018 The Python Packaging Authority Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "Parse EML file and export the information extracted as JSON.",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/maheshkumaarbalaji/EMLMailReader",
"Issues": "https://github.com/maheshkumaarbalaji/EMLMailReader/issues"
},
"split_keywords": [
"email",
" reader",
" eml",
" parser"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7f1ec038bbb3776d7d455c306d1633a61b5cfbc7824b34f1c5496872e76a15da",
"md5": "24349d08d6becfa1ce25ee6f3aefd1e2",
"sha256": "c886d79b4eab6ba7f2753f7b1eccd2ad1e1cd1fb20376a037e7c9a2fc1ff92de"
},
"downloads": -1,
"filename": "emlmailreader-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "24349d08d6becfa1ce25ee6f3aefd1e2",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 25711,
"upload_time": "2024-03-29T17:36:06",
"upload_time_iso_8601": "2024-03-29T17:36:06.798712Z",
"url": "https://files.pythonhosted.org/packages/7f/1e/c038bbb3776d7d455c306d1633a61b5cfbc7824b34f1c5496872e76a15da/emlmailreader-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c1b196a416fc892e2e5dcc0b3b93e55be7bfb0912d9850e7a17709e9961c508d",
"md5": "f080f005bd514913330f645bb549b0c7",
"sha256": "e12f1b9d7eaacd2d17ae074b243bc8d1e57bb726db008c5375eae19722a0c910"
},
"downloads": -1,
"filename": "emlmailreader-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "f080f005bd514913330f645bb549b0c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 35554,
"upload_time": "2024-03-29T17:36:08",
"upload_time_iso_8601": "2024-03-29T17:36:08.779925Z",
"url": "https://files.pythonhosted.org/packages/c1/b1/96a416fc892e2e5dcc0b3b93e55be7bfb0912d9850e7a17709e9961c508d/emlmailreader-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-29 17:36:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maheshkumaarbalaji",
"github_project": "EMLMailReader",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "emlmailreader"
}
