Welcome to msg parser’s documentation!¶
msg_parser¶
Python module for parsing outlook msg files.
- Free software: BSD license
- Documentation: https://msg-parser.readthedocs.io.
Features¶
- Parse MSG file.
- Convert MSG file to EML file.
- Output MSG file as JSON string.
- Handles nested MSG/EML attachments.
- Works 100% on Linux machines, do not require any windows libraries.
Installation¶
Basic installation
pip install msg_parser
With RTF decompression
pip install msg_parser[rtf]
Usage¶
Run CLI command
$ msg_parser --help usage: msg_parser [-h] -i FILE [-j] [-e EML_FILE] Microsoft Message Parser optional arguments: -h, --help show this help message and exit -i FILE, --input FILE msg file path -j, --json output parsed msg as json to console -e EML_FILE, --eml EML_FILE provide email file path to save as eml file.
Import in python modules
from msg_parser import MsOxMessage msg_obj = MsOxMessage(msg_file_path) json_string = msg_obj.get_message_as_json() msg_properties_dict = msg_obj.get_properties() saved_path = msg_obj.save_email_file(output_eml_file_path)
Installation¶
Stable release¶
To install msg_parser, run this command in your terminal:
$ pip install msg_parser
This is the preferred method to install msg_parser, as it will always install the most recent stable release.
If you don’t have pip installed, this Python installation guide can guide you through the process.
From sources¶
The sources for msg_parser can be downloaded from the Github repo.
You can either clone the public repository:
$ git clone git://github.com/vikramarsid/msg_parser
Or download the tarball:
$ curl -OL https://github.com/vikramarsid/msg_parser/tarball/master
Once you have a copy of the source, you can install it with:
$ python setup.py install
Usage¶
To use msg_parser in a project:
from msg_parser import MsOxMessage
msg_obj = MsOxMessage(msg_file_path)
json_string = msg_obj.get_message_as_json()
msg_properties_dict = msg_obj.get_properties()
saved_path = msg_obj.save_email_file(output_eml_file_path)
msg_parser¶
msg_parser package¶
Subpackages¶
Submodules¶
msg_parser.cli module¶
Console script for msg_parser.
msg_parser.email_builder module¶
msg_parser.msg_parser module¶
-
class
msg_parser.msg_parser.Attachment(attachment_properties)[source]¶ Bases:
objectclass to store attachment attributes
-
class
msg_parser.msg_parser.Message(directory_entries)[source]¶ Bases:
objectClass to store Message properties
-
class
msg_parser.msg_parser.MsOxMessage(msg_file_path)[source]¶ Bases:
objectBase class for Microsoft Message Object
Module contents¶
Top-level package for msg_parser.
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/vikramarsid/msg_parser/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.
Write Documentation¶
msg_parser could always use more documentation, whether as part of the official msg_parser docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/vikramarsid/msg_parser/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up msg_parser for local development.
Fork the msg_parser repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/msg_parser.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv msg_parser $ cd msg_parser/ $ python setup.py developCreate a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:
$ flake8 msg_parser tests $ python setup.py test or py.test $ toxTo get flake8 and tox, just pip install them into your virtualenv.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-featureSubmit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
- The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check https://travis-ci.org/vikramarsid/msg_parser/pull_requests and make sure that the tests pass for all supported Python versions.
Deploying¶
A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:
$ bumpversion patch # possible: major / minor / patch
$ git push
$ git push --tags
Travis will then deploy to PyPI if tests pass.
Credits¶
Development Lead¶
- Vikram Arsid <vikramarsid@gmail.com>
Contributors¶
None yet. Why not be the first?