A django email backend that saves the emails to database instead of sending them, and can view the emails in a web-browser
Project description
django-developmentEmailDashboard
A django email backend that saves the emails to database instead of sending them and can view the emails in a web-browser
:warning: disclaimer: do not use this in production or on any public server. this app hardly has any security protocols inplace since this is meant to be used in development and values ease of use over security. for example there is no password required to view a users inbox or to create a new one or for anything else.
Installation
-
prerequisites
- must have static files configured
- optional to get windows notifications install zroya
pip install zroya
-
run
pip install django-developmentEmailDashboard
-
Add 'developmentEmailDashboard' to your INSTALLED_APPS setting.
-
Add urls (only add the urls file that you plan on using)
from django.conf import settings
...
if settings.DEBUG: urlpatterns.append(path('emails/', include('developmentEmailDashboard.urls')))
-
set the email backend in settings.py
if DEBUG: EMAIL_BACKEND = 'developmentEmailDashboard.emailbackend.developmentEmailBackend'
-
Run the command
manage.py migrate
.
now every time you send an email it will show up on your website at http://localhost:8000/emails/
there is no validation on the emails that get created in the dashboard. for example you can create a inbox
test
or@@@
and it will work this is done for convenience if users want this functionality to be changed that can be done
configuration
get notified when you receive an email
in settings.py setDEVELOPMENT_EMAIL_DASHBOARD_SEND_EMAIL_NOTIFICATION = True
to get a windows notification
every time an email is received
must have zroya installed |
pip install zroya
changelog
2.0.0
added windows notifications
fixed bug where text based emails don't display new lines properly
fixed bug where deleting inbox creates does not exist error
2.0.1
fixed bug where when zroya init fails to send email notification it raises 500 error now ignores it
2.0.2
when zroya init fails to load still tries to send notification
still left to do
- amazing documentation
- 100% testing coverage
- fix icons displaying centered
- render emails as they will be displayed in a email application not just html
- option to show raw email with headers
- add email attachments
- allow browser to send html emails not just view emails with html sent by websites
- management command to delete database tables, clear tables, create tables again
Any contribution is welcome just make a pull request, and I will try to add your feature in the next version as soon as possible.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django-developmentEmailDashboard-2.0.2.tar.gz
.
File metadata
- Download URL: django-developmentEmailDashboard-2.0.2.tar.gz
- Upload date:
- Size: 917.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.7.1 importlib_metadata/4.9.0 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 09c6ccc95bbe0cf61915f979a69e460f50fc4eb159305a4a9910f21286523566 |
|
MD5 | eb02dec8287a3b18875ccc4b4d0bf07e |
|
BLAKE2b-256 | 67ba4f9d29bfee56fec356b95906589ca620d7a3017e182ceaefd1919f581522 |