=============================
Django Mail Viewer
=============================
.. image:: https://badge.fury.io/py/django-mail-viewer.png
:target: https://badge.fury.io/py/django-mail-viewer
.. image:: https://github.com/jmichalicek/django-mail-viewer/workflows/Python%20package/badge.svg
:target: https://github.com/jmichalicek/django-mail-viewer/actions?query=workflow%3A%22Python+package%22
View emails in development without actually sending them.
Documentation
-------------
The full documentation is at https://django-mail-viewer.readthedocs.io.
Quickstart
----------
Install Django Mail Viewer::
pip install django-mail-viewer
Add it to your `INSTALLED_APPS`:
.. code-block:: python
INSTALLED_APPS = (
...
'django_mail_viewer',
...
)
Add Django Mail Viewer's URL patterns:
.. code-block:: python
# You may want to only include this in development environments
urlpatterns = [
...
path('', include('django_mail_viewer.urls')),
...
]
Set your `EMAIL_BACKEND` in settings.py:
.. code-block:: python
EMAIL_BACKEND = 'django_mail_viewer.backends.locmem.EmailBackend'
Features
--------
* TODO
Running Tests
-------------
Does the code actually work?
::
source <YOURVIRTUALENV>/bin/activate
(myenv) $ pip install tox
(myenv) $ tox
TODO
-----
* Passthrough backend - store the email for display in the views but also pass to another backend which may actually send
* Redis backend using Redis specific functionality for cleaner code and less risk of bugs vs the django cache backend
* Memcached backend
* File based backend - store each email as its own file
* Other backends? ElasticSearch? MongoDB?
* Separate views for each of html, plaintext, attachements, etc. to allow for more customization of display?
Credits
-------
Tools used in rendering this package:
* Cookiecutter_
* `cookiecutter-djangopackage`_
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage
Raw data
{
"_id": null,
"home_page": "https://github.com/jmichalicek/django-mail-viewer",
"name": "django-mail-viewer",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "django-mail-viewer,django,email",
"author": "Justin Michalicek",
"author_email": "jmichalicek@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ab/c9/b7e7a1f682ffb5bdd85259bcfa839f024c9e6dfd92c2c17b3502b656039b/django-mail-viewer-2.1.0.tar.gz",
"platform": null,
"description": "=============================\nDjango Mail Viewer\n=============================\n\n.. image:: https://badge.fury.io/py/django-mail-viewer.png\n :target: https://badge.fury.io/py/django-mail-viewer\n\n.. image:: https://github.com/jmichalicek/django-mail-viewer/workflows/Python%20package/badge.svg\n :target: https://github.com/jmichalicek/django-mail-viewer/actions?query=workflow%3A%22Python+package%22\n\nView emails in development without actually sending them.\n\nDocumentation\n-------------\n\nThe full documentation is at https://django-mail-viewer.readthedocs.io.\n\nQuickstart\n----------\n\nInstall Django Mail Viewer::\n\n pip install django-mail-viewer\n\nAdd it to your `INSTALLED_APPS`:\n\n.. code-block:: python\n\n INSTALLED_APPS = (\n ...\n 'django_mail_viewer',\n ...\n )\n\nAdd Django Mail Viewer's URL patterns:\n\n.. code-block:: python\n\n # You may want to only include this in development environments\n\n urlpatterns = [\n ...\n path('', include('django_mail_viewer.urls')),\n ...\n ]\n\nSet your `EMAIL_BACKEND` in settings.py:\n\n.. code-block:: python\n\n EMAIL_BACKEND = 'django_mail_viewer.backends.locmem.EmailBackend'\n\nFeatures\n--------\n\n* TODO\n\nRunning Tests\n-------------\n\nDoes the code actually work?\n\n::\n\n source <YOURVIRTUALENV>/bin/activate\n (myenv) $ pip install tox\n (myenv) $ tox\n\n\nTODO\n-----\n\n* Passthrough backend - store the email for display in the views but also pass to another backend which may actually send\n* Redis backend using Redis specific functionality for cleaner code and less risk of bugs vs the django cache backend\n* Memcached backend\n* File based backend - store each email as its own file\n* Other backends? ElasticSearch? MongoDB?\n* Separate views for each of html, plaintext, attachements, etc. to allow for more customization of display?\n\nCredits\n-------\n\nTools used in rendering this package:\n\n* Cookiecutter_\n* `cookiecutter-djangopackage`_\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "View emails in development without actually sending them.",
"version": "2.1.0",
"split_keywords": [
"django-mail-viewer",
"django",
"email"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "0ca460007e453fc8cc022ebb64c924eb",
"sha256": "45f04c0a1efdc2e700a6c0e376df9d39474b02036b16f3ac85db32b4f7bff9c8"
},
"downloads": -1,
"filename": "django_mail_viewer-2.1.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "0ca460007e453fc8cc022ebb64c924eb",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 22950,
"upload_time": "2022-12-11T04:28:08",
"upload_time_iso_8601": "2022-12-11T04:28:08.198332Z",
"url": "https://files.pythonhosted.org/packages/40/66/a4ceb8cbb71917c5d444fad99730ab535c4f92ca589cd4e0a5d2f4355df2/django_mail_viewer-2.1.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "25665a4aeb19235a79bd5c6b9325a328",
"sha256": "24186b2e1ab5959daa06bddc84abf69b0248a8573b0431d4117b6703c6fd7aa2"
},
"downloads": -1,
"filename": "django-mail-viewer-2.1.0.tar.gz",
"has_sig": false,
"md5_digest": "25665a4aeb19235a79bd5c6b9325a328",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 27461,
"upload_time": "2022-12-11T04:28:10",
"upload_time_iso_8601": "2022-12-11T04:28:10.401058Z",
"url": "https://files.pythonhosted.org/packages/ab/c9/b7e7a1f682ffb5bdd85259bcfa839f024c9e6dfd92c2c17b3502b656039b/django-mail-viewer-2.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-11 04:28:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "jmichalicek",
"github_project": "django-mail-viewer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "django-mail-viewer"
}