diff --git a/CHANGELOG.md b/CHANGELOG.md index ee2596d..822cc87 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,10 +5,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), [Also based on](https://github.com/conventional-changelog/standard-version/blob/master/CHANGELOG.md) so decending. +## [0.1.1] - 2021-02-03 +### Added +- adds modified documenation + ## [0.1.0] - 2021-02-03 ### Added - bot - adds changelog ### Changed - changes repo to customized solution - diff --git a/django_mailbox/transports/imap.py b/django_mailbox/transports/imap.py index a5bd616..fc19a34 100644 --- a/django_mailbox/transports/imap.py +++ b/django_mailbox/transports/imap.py @@ -38,7 +38,7 @@ class ImapTransport(EmailTransport): ) self.delete_message_store = getattr( settings, - 'DJANGO_MAILBOX_DELETE_MESSAGE_STORE', + 'DJANGO_MAILBOX_DELETE_MESSAGE_ID_STORE', "/tmp/store.json" ) self.hostname = hostname diff --git a/readme.rst b/readme.rst index 0aac06b..607db62 100644 --- a/readme.rst +++ b/readme.rst @@ -1,14 +1,7 @@ -.. image:: https://travis-ci.org/coddingtonbear/django-mailbox.png?branch=master - :target: https://travis-ci.org/coddingtonbear/django-mailbox -.. image:: https://badge.fury.io/py/django-mailbox.png - :target: http://badge.fury.io/py/django-mailbox +Easily ingest messages from POP3, IMAP, or local mailboxes into your Django application. -.. image:: https://pypip.in/d/django-mailbox/badge.png - :target: https://pypi.python.org/pypi/django-mailbox - - -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). @@ -16,14 +9,26 @@ or directly receive e-mail messages from ``stdin`` (for locally processing messa 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 project’s 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 project’s 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 `_. - Please post issues on `Github `_. - Test status available on `Travis-CI `_. - - -.. image:: https://badges.gitter.im/Join%20Chat.svg - :alt: Join the chat at https://gitter.im/coddingtonbear/django-mailbox - :target: https://gitter.im/coddingtonbear/django-mailbox?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge \ No newline at end of file