mail-cleaner
============
:Version: 2.0.0
:Source: https://github.com/maykinmedia/mail-cleaner
:Keywords: django, email, sanitize
:PythonVersion: 3.9
|build-status| |code-quality| |black| |coverage| |docs|
|python-versions| |django-versions| |pypi-version|
Handle and sanitize HTML & text emails
.. contents::
.. section-numbering::
Features
========
* Sanitize untrusted links
* Best-effort plain-text message extraction from HTML e-mails
Installation
============
Install
-------
.. code-block:: bash
pip install mail-cleaner
Usage
=====
See the usage `documentation <https://mail-cleaner.readthedocs.io/en/latest/>`_.
Local development
=================
To install and develop the library locally, use:
.. code-block:: bash
pip install --no-build-isolation -e .[tests,coverage,docs,pep8,release]
.. |build-status| image:: https://github.com/maykinmedia/mail-cleaner/workflows/Run%20CI/badge.svg
:alt: Build status
:target: https://github.com/maykinmedia/mail-cleaner/actions?query=workflow%3A%22Run+CI%22
.. |code-quality| image:: https://github.com/maykinmedia/mail-cleaner/workflows/Code%20quality%20checks/badge.svg
:alt: Code quality checks
:target: https://github.com/maykinmedia/mail-cleaner/actions?query=workflow%3A%22Code+quality+checks%22
.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
.. |coverage| image:: https://codecov.io/gh/maykinmedia/mail-cleaner/branch/master/graph/badge.svg
:target: https://codecov.io/gh/maykinmedia/mail-cleaner
:alt: Coverage status
.. |docs| image:: https://readthedocs.org/projects/mail-cleaner/badge/?version=latest
:target: https://mail-cleaner.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |python-versions| image:: https://img.shields.io/pypi/pyversions/mail-cleaner.svg
.. |django-versions| image:: https://img.shields.io/pypi/djversions/mail-cleaner.svg
.. |pypi-version| image:: https://img.shields.io/pypi/v/mail-cleaner.svg
:target: https://pypi.org/project/mail-cleaner/
Raw data
{
"_id": null,
"home_page": "https://github.com/maykinmedia/mail-cleaner",
"name": "mail-cleaner",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "django, email, sanitize",
"author": "Maykin Media",
"author_email": "support@maykinmedia.nl",
"download_url": "https://files.pythonhosted.org/packages/ed/01/94700ee5c93ed70ea9cdf76fdfdb4adaea4667f85688fbe209365a956de9/mail_cleaner-2.0.0.tar.gz",
"platform": null,
"description": "mail-cleaner\n============\n\n:Version: 2.0.0\n:Source: https://github.com/maykinmedia/mail-cleaner\n:Keywords: django, email, sanitize\n:PythonVersion: 3.9\n\n|build-status| |code-quality| |black| |coverage| |docs|\n\n|python-versions| |django-versions| |pypi-version|\n\nHandle and sanitize HTML & text emails\n\n.. contents::\n\n.. section-numbering::\n\nFeatures\n========\n\n* Sanitize untrusted links\n* Best-effort plain-text message extraction from HTML e-mails\n\nInstallation\n============\n\nInstall\n-------\n\n.. code-block:: bash\n\n pip install mail-cleaner\n\n\nUsage\n=====\n\nSee the usage `documentation <https://mail-cleaner.readthedocs.io/en/latest/>`_.\n\nLocal development\n=================\n\nTo install and develop the library locally, use:\n\n.. code-block:: bash\n\n pip install --no-build-isolation -e .[tests,coverage,docs,pep8,release]\n\n\n.. |build-status| image:: https://github.com/maykinmedia/mail-cleaner/workflows/Run%20CI/badge.svg\n :alt: Build status\n :target: https://github.com/maykinmedia/mail-cleaner/actions?query=workflow%3A%22Run+CI%22\n\n.. |code-quality| image:: https://github.com/maykinmedia/mail-cleaner/workflows/Code%20quality%20checks/badge.svg\n :alt: Code quality checks\n :target: https://github.com/maykinmedia/mail-cleaner/actions?query=workflow%3A%22Code+quality+checks%22\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n.. |coverage| image:: https://codecov.io/gh/maykinmedia/mail-cleaner/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/maykinmedia/mail-cleaner\n :alt: Coverage status\n\n.. |docs| image:: https://readthedocs.org/projects/mail-cleaner/badge/?version=latest\n :target: https://mail-cleaner.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |python-versions| image:: https://img.shields.io/pypi/pyversions/mail-cleaner.svg\n\n.. |django-versions| image:: https://img.shields.io/pypi/djversions/mail-cleaner.svg\n\n.. |pypi-version| image:: https://img.shields.io/pypi/v/mail-cleaner.svg\n :target: https://pypi.org/project/mail-cleaner/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Handle and sanitize HTML & text emails",
"version": "2.0.0",
"project_urls": {
"Bug Tracker": "https://github.com/maykinmedia/mail-cleaner/issues",
"Changelog": "https://github.com/maykinmedia/mail-cleaner/blob/main/CHANGELOG.rst",
"Documentation": "http://mail-cleaner.readthedocs.io/en/latest/",
"Homepage": "https://github.com/maykinmedia/mail-cleaner",
"Source Code": "https://github.com/maykinmedia/mail-cleaner"
},
"split_keywords": [
"django",
" email",
" sanitize"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "8d7ad618ed0142c6ccc53b7d415d838dc9b15503ac1ae26dd65740c9a48bf722",
"md5": "bfef112e73c0a31d8721dbad64854fbc",
"sha256": "45a208d042476eec41517108d255c546eccb0a10a7bc2256aeaf876c37507a42"
},
"downloads": -1,
"filename": "mail_cleaner-2.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bfef112e73c0a31d8721dbad64854fbc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8684,
"upload_time": "2025-08-21T10:20:34",
"upload_time_iso_8601": "2025-08-21T10:20:34.522565Z",
"url": "https://files.pythonhosted.org/packages/8d/7a/d618ed0142c6ccc53b7d415d838dc9b15503ac1ae26dd65740c9a48bf722/mail_cleaner-2.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "ed0194700ee5c93ed70ea9cdf76fdfdb4adaea4667f85688fbe209365a956de9",
"md5": "a3abcba38a953bf5b7b48e560b175360",
"sha256": "84f32e1272a3fa5ab7cba92446432916f14480983338eb9f33c0ac06252bbb92"
},
"downloads": -1,
"filename": "mail_cleaner-2.0.0.tar.gz",
"has_sig": false,
"md5_digest": "a3abcba38a953bf5b7b48e560b175360",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11181,
"upload_time": "2025-08-21T10:20:35",
"upload_time_iso_8601": "2025-08-21T10:20:35.461993Z",
"url": "https://files.pythonhosted.org/packages/ed/01/94700ee5c93ed70ea9cdf76fdfdb4adaea4667f85688fbe209365a956de9/mail_cleaner-2.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-21 10:20:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maykinmedia",
"github_project": "mail-cleaner",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "mail-cleaner"
}
JSON
