=============================
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": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "django-mail-viewer, django, email",
"author": "Justin Michalicek",
"author_email": "jmichalicek@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b8/48/1aab7009bd71aafa9d6f0a0f2fff40c8d7bc1ce465cce892242594c041e2/django_mail_viewer-2.2.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.2.0",
"project_urls": {
"Homepage": "https://github.com/jmichalicek/django-mail-viewer"
},
"split_keywords": [
"django-mail-viewer",
" django",
" email"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "81740ee6455c161edb0c18fb7f7b2f314d31b6a4fc69d955022b967eb141f776",
"md5": "ad7eb3213214a2bf9d7fe04d7dd33f01",
"sha256": "ca5f6afaf1f4c212a90953907d6d946a90e595ed9fce49da6c3a3ea0034c9631"
},
"downloads": -1,
"filename": "django_mail_viewer-2.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ad7eb3213214a2bf9d7fe04d7dd33f01",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 23562,
"upload_time": "2024-07-19T21:49:13",
"upload_time_iso_8601": "2024-07-19T21:49:13.768551Z",
"url": "https://files.pythonhosted.org/packages/81/74/0ee6455c161edb0c18fb7f7b2f314d31b6a4fc69d955022b967eb141f776/django_mail_viewer-2.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b8481aab7009bd71aafa9d6f0a0f2fff40c8d7bc1ce465cce892242594c041e2",
"md5": "8ce56760837fd474dcb32cd8effb137c",
"sha256": "638b6d57bfcb9306e1774e5a9e77b960963c87443fd69906efcece496639ccf0"
},
"downloads": -1,
"filename": "django_mail_viewer-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "8ce56760837fd474dcb32cd8effb137c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 32908,
"upload_time": "2024-07-19T21:49:15",
"upload_time_iso_8601": "2024-07-19T21:49:15.265547Z",
"url": "https://files.pythonhosted.org/packages/b8/48/1aab7009bd71aafa9d6f0a0f2fff40c8d7bc1ce465cce892242594c041e2/django_mail_viewer-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-19 21:49:15",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jmichalicek",
"github_project": "django-mail-viewer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "django-mail-viewer"
}
JSON
