Overview
mail-parser is a wrapper for email Python Standard Library. It’s the key module of SpamScope.
From version 1.0.0rc1 mail-parser supports Python 3.
Description
mail-parser takes as input a raw mail and generates a parsed object. This object is a tokenized mail with the all parts of mail and some indicator: - body - headers - subject - from - to - attachments - message id - date - charset mail - sender IP address
We have also two indicator: - anomalies: mail without message id or date - defects: mail with some not compliance RFC part
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.
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 class:
from mailparser import MailParser parser = MailParser() parser.parse_from_file(f) parser.parse_from_string(raw_mail)
Then you can get all parts
parser.body parser.headers parser.message_id parser.to_ parser.from_ parser.subject parser.text_plain_list: only text plain mail parts in a list parser.attachments_list: list of all attachments parser.date_mail parser.parsed_mail_obj: tokenized mail in a object parser.parsed_mail_json: tokenized mail in a JSON parser.defects: defect RFC non compliance parser.defects_category: only defects categories parser.has_defects parser.anomalies parser.has_anomalies parser.get_server_ipaddress(trust="my_server_mail_trust")
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_) [-j] [-b] [-a] [-r] [-t] [-m]
[-u] [-d] [-n]
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)
-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)
-m, --from Print the from of mail (default: False)
-u, --subject Print the subject of mail (default: False)
-d, --defects Print the defects of mail (default: False)
-n, --anomalies Print the anomalies of mail (default: False)
-i Trust mail server string, --senderip Trust mail server string
Extract a reliable sender IP address heuristically
(default: None)
-v, --version show program's version number and exit
It takes as input a raw mail and generates a parsed object.
Example:
$ mailparser -f example_mail -jThis example will show you the tokenized mail in a JSON pretty format.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file mail-parser-1.1.0.tar.gz.
File metadata
- Download URL: mail-parser-1.1.0.tar.gz
- Upload date:
- Size: 7.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
29032bc9f8c5af5e1e0995cefea32db5761855e88e0d92d7d84834b5ea3ae113
|
|
| MD5 |
4dec09c199d4edfe5d1f659f3fe9f69f
|
|
| BLAKE2b-256 |
54e40bc934b397dd7463316db33f873680fb9ed3f6b08c7d765f6ac265b7fb78
|
