1
0
Fork 1
mirror of https://github.com/coddingtonbear/django-mailbox.git synced 2026-07-09 22:38:19 +02:00
No description
Find a file
2021-02-03 21:51:54 -05:00
django_mailbox adds modified documenation 2021-02-03 21:51:54 -05:00
docs Add tests docs to CI and fix docs warning (#238) 2020-12-06 18:10:15 -08:00
.bumpversion.cfg Bump version: 4.8.1 → 4.8.2 2020-12-06 18:11:32 -08:00
.flake8 Add flake8 style check 2017-05-09 23:59:42 +02:00
.gitignore lets try this new method. 2021-02-01 12:08:09 -05:00
.travis.yml Add tests docs to CI and fix docs warning (#238) 2020-12-06 18:10:15 -08:00
CHANGELOG.md adds modified documenation 2021-02-03 21:51:54 -05:00
LICENSE Adding license. 2014-02-22 20:01:30 -08:00
Makefile changes repo to customized solution 2021-02-03 20:58:11 -05:00
MANIFEST.in Add locale files to package 2017-07-09 13:35:26 +03:00
pyproject.toml changes repo to customized solution 2021-02-03 20:58:11 -05:00
readme.rst adds modified documenation 2021-02-03 21:51:54 -05:00
setup.cfg Switch from nose to py.test. 2016-05-14 22:06:32 -07:00
setup.py Modernize syntax, drop Python EOL, drop drop Django<1.11, upgrade TravisCI config to v1, add Python 3.8 & Django 3.x 2019-11-09 19:23:08 +01:00

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

Easily ingest messages from POP3, IMAP, or local mailboxes into your Django application. 

This is a modified version that has extra features. I think I need to make it better.

This app allows you to either ingest e-mail content from common e-mail services (as long as the service provides POP3 or IMAP support),
or directly receive e-mail messages from ``stdin`` (for locally processing messages from Postfix or Exim4).

These ingested messages will be stored in the database in Django models and you can process their content at will,
or -- if you're in a hurry -- by using a signal receiver.


### Usage

1. poetry add django-mailbox

2. After you have installed the package, add django_mailbox to the INSTALLED_APPS setting in your projects settings.py file.

3. From your project folder, run python manage.py migrate django_mailbox to create the required database tables.

4. Head to your projects Django Admin and create a mailbox to consume.
  a. if you do not want it to delete the messages on the server add these to settings.py
     set DJANGO_MAILBOX_DELETE_MESSAGE_FROM_SERVER to false
     set DJANGO_MAILBOX_DELETE_MESSAGE_ID_STORE to /path/to/messageid_store.json

5. python manage.py getmail


- Documentation for django-mailbox is available on
  `ReadTheDocs <http://django-mailbox.readthedocs.org/>`_.
- Please post issues on
  `Github <http://github.com/coddingtonbear/django-mailbox/issues>`_.
- Test status available on
  `Travis-CI <https://travis-ci.org/coddingtonbear/django-mailbox>`_.