mirror of
https://github.com/coddingtonbear/django-mailbox.git
synced 2026-07-09 22:38:19 +02:00
40 lines
1.5 KiB
ReStructuredText
40 lines
1.5 KiB
ReStructuredText
.. django-mailbox documentation master file, created by
|
|
sphinx-quickstart on Tue Jan 22 20:29:12 2013.
|
|
You can adapt this file completely to your liking, but it should at least
|
|
contain the root `toctree` directive.
|
|
|
|
Django-mailbox
|
|
==============
|
|
|
|
.. image:: https://travis-ci.org/coddingtonbear/django-mailbox.png?branch=master
|
|
:target: https://travis-ci.org/coddingtonbear/django-mailbox
|
|
|
|
How many times have you had to consume some sort of POP3, IMAP, or local mailbox for incoming content,
|
|
or had to otherwise construct an application driven by e-mail?
|
|
One too many times, I'm sure.
|
|
|
|
This small Django application will allow you to specify mailboxes that you would like consumed for incoming content;
|
|
the e-mail will be stored, and you can process it at will (or, if you're in a hurry, by subscribing to a signal).
|
|
|
|
The Django-mailbox retrieves the e-mail messages by eg. IMAP, POP and then erases them to not download again the next time. Django-mailbox is not a typical mail program, and is a development library that makes it easy to process email messages in Django. A mailbox in that case plays the role of a message queue that needs to be processed. Messages processed from the queue are removed from the queue.
|
|
|
|
Contents:
|
|
|
|
.. toctree::
|
|
:maxdepth: 3
|
|
|
|
topics/installation
|
|
topics/mailbox_types
|
|
topics/polling
|
|
topics/signal
|
|
topics/development
|
|
topics/appendix
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|
|
|