mail-cleaner


Namemail-cleaner JSON
Version 1.1.0 PyPI version JSON
download
home_pagehttps://github.com/maykinmedia/mail-cleaner
SummaryHandle and sanitize HTML & text emails
upload_time2023-01-18 13:24:58
maintainer
docs_urlNone
authorMaykin Media
requires_python
licenseMIT
keywords django email sanitize
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            mail-cleaner
============

:Version: 1.1.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": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "django,email,sanitize",
    "author": "Maykin Media",
    "author_email": "support@maykinmedia.nl",
    "download_url": "https://files.pythonhosted.org/packages/81/fe/958983b8c18aa28e60c203e32929cb7c5c4d23993ac050e88d67aa61f62c/mail-cleaner-1.1.0.tar.gz",
    "platform": null,
    "description": "mail-cleaner\n============\n\n:Version: 1.1.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": "1.1.0",
    "split_keywords": [
        "django",
        "email",
        "sanitize"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "28a14239e0c3670415959c0863a54fe5f59b8b4d51064d984ac6096b0024ca50",
                "md5": "63812cc3d0593bc91dcbc480fd3b3686",
                "sha256": "47bf5db32e370611cd9c310a043fef185c567ae7d3bd2c3e9488ea499a4b44d8"
            },
            "downloads": -1,
            "filename": "mail_cleaner-1.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "63812cc3d0593bc91dcbc480fd3b3686",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 8622,
            "upload_time": "2023-01-18T13:24:56",
            "upload_time_iso_8601": "2023-01-18T13:24:56.535859Z",
            "url": "https://files.pythonhosted.org/packages/28/a1/4239e0c3670415959c0863a54fe5f59b8b4d51064d984ac6096b0024ca50/mail_cleaner-1.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "81fe958983b8c18aa28e60c203e32929cb7c5c4d23993ac050e88d67aa61f62c",
                "md5": "26e9725d705433a1fd25552fb81037d8",
                "sha256": "e3783fbc137e8d30817804ea20455ee409929c04115f15beddf2c3d26b37da0b"
            },
            "downloads": -1,
            "filename": "mail-cleaner-1.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "26e9725d705433a1fd25552fb81037d8",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 8922,
            "upload_time": "2023-01-18T13:24:58",
            "upload_time_iso_8601": "2023-01-18T13:24:58.298409Z",
            "url": "https://files.pythonhosted.org/packages/81/fe/958983b8c18aa28e60c203e32929cb7c5c4d23993ac050e88d67aa61f62c/mail-cleaner-1.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-18 13:24:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "maykinmedia",
    "github_project": "mail-cleaner",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "mail-cleaner"
}
        
Elapsed time: 0.02876s