federico/django-mailbox
1
0
Fork 0
forked from mirror/django-mailbox
Code Activity

Bumping version number.

Browse source
This commit is contained in:
Adam Coddington 2012-07-21 15:40:46 -07:00
commit bfa4c58013
6 changed files with 16 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

20
readme.rst Normal file → Executable file
View file

@ -1,11 +1,11 @@
Introduction
~~~~~~~~~~~~
How many times have you had to consume some sort of POP3 or IMAP mailbox for incoming content? One too many times for me.
How many times have you had to consume some sort of POP3, IMAP, or local mailbox for incoming content? One too many times for me.
This small Django application will allow you to specify IMAP or POP3 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).
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).
WARNING! This app will delete any messages it can find in the inbox you specify-- please make sure you don't have anything important in there.
WARNING! This will delete any messages it can find in the inbox you specify-- please make sure you don't have anything important in there.
Installation
============
@ -31,10 +31,10 @@ Setting up your mailbox
Django Mailbox supports both common internet mailboxes like POP3 and IMAP as well as local file-based mailboxes.
.. table:: Protocol Options
.. table:: 'Protocol' Options
============ ============== =========================================
Mailbox Type 'Protocol' Notes
Mailbox Type 'Protocol':// Notes
============ ============== =========================================
POP3 ``pop3://`` Can also specify SSL with ``pop3+ssl://``
IMAP ``imap://`` Can also specify SSL with ``imap+ssl://``
@ -53,23 +53,23 @@ Mailbox URIs are in the normal URI format::
protocol://username:password@domain
Basic IMAP Example: ``imap://username:password@server``
Basic POP3 Example: ``pop3://username:password@server``
Most mailboxes these days are SSL-enabled; if yours is, add ``+ssl`` to your URI. Also, if your username or password include any non-ascii characters, they should be URL-encoded (for example, if your username includes an ``@``, it should be changed to ``%40`` in your URI).
If you have an account named 'contemporanea@gmail.com' with a password of '1234' on GMail (which I happen to know uses the POP3 server of 'pop.gmail.com' and requires SSL), you would enter the following as your URI::
If you have an account named ``youremailaddress@gmail.com`` with a password of ``1234`` on GMail (which I happen to know uses the POP3 server of 'pop.gmail.com' and requires SSL), you would enter the following as your URI::
pop3+ssl://contemporanea%40gmail.com:1234@pop.gmail.com
pop3+ssl://youremailaddress%40gmail.com:1234@pop.gmail.com
Local File-based Mailboxes
--------------------------
If you happen to want to consume a file-based mailbox like an Maildir, Mbox, Babyl, MH, or MMDF mailbox, you can use this too by entering the appropriate 'protocol' in the URI. If you had a maildir, for example, at @/var/mail/@, you would enter a URI like::
If you happen to want to consume a file-based mailbox like an Maildir, Mbox, Babyl, MH, or MMDF mailbox, you can use this too by entering the appropriate 'protocol' in the URI. If you had a maildir, for example, at ``/var/mail/``, you would enter a URI like::
maildir:///var/mail
.. important::
Note that there are three slashes in the above URI.
Note that there is an additional ``/`` in the above URI after the protocol; this is important.
Subscribing to the incoming mail signal
=======================================