Merging in pipe-based mail consumer.

django_mailbox/management/commands/processincomingmessage.py

@@ -0,0 +1,28 @@
+import email
+import logging
+import rfc822
+import sys
+
+from django.core.management.base import BaseCommand
+
+from django_mailbox.models import Mailbox
+
+logger = logging.getLogger(__name__)
+logging.basicConfig(level=logging.INFO)
+
+class Command(BaseCommand):
+    def handle(self, *args, **options):
+        message = email.message_from_string(sys.stdin.read())
+        if message:
+            mailbox = self.get_mailbox_for_message(message)
+            mailbox.process_incoming_message(message)
+            logger.info("Message received from %s" % message['from'])
+        else:
+            logger.warning("Message not processable.")
+
+    def get_mailbox_for_message(self, message):
+        email_address = rfc822.parseaddr(message['to'])[1][0:255]
+        mailbox, created = Mailbox.objects.get_or_create(
+                name=email_address,
+                )
+        return mailbox

django_mailbox/migrations/0002_auto__chg_field_mailbox_uri.py

@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+import datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+
+        # Changing field 'Mailbox.uri'
+        db.alter_column('django_mailbox_mailbox', 'uri', self.gf('django.db.models.fields.CharField')(max_length=255, null=True))
+
+    def backwards(self, orm):
+
+        # User chose to not deal with backwards NULL issues for 'Mailbox.uri'
+        raise RuntimeError("Cannot reverse this migration. 'Mailbox.uri' and its values cannot be restored.")
+
+    models = {
+        'django_mailbox.mailbox': {
+            'Meta': {'object_name': 'Mailbox'},
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'name': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'uri': ('django.db.models.fields.CharField', [], {'default': 'None', 'max_length': '255', 'null': 'True', 'blank': 'True'})
+        },
+        'django_mailbox.message': {
+            'Meta': {'object_name': 'Message'},
+            'body': ('django.db.models.fields.TextField', [], {}),
+            'from_address': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'mailbox': ('django.db.models.fields.related.ForeignKey', [], {'related_name': "'messages'", 'to': "orm['django_mailbox.Mailbox']"}),
+            'message_id': ('django.db.models.fields.CharField', [], {'max_length': '255'}),
+            'received': ('django.db.models.fields.DateTimeField', [], {'auto_now_add': 'True', 'blank': 'True'}),
+            'subject': ('django.db.models.fields.CharField', [], {'max_length': '255'})
+        }
+    }
+
+    complete_apps = ['django_mailbox']

django_mailbox/models.py

@@ -22,7 +22,10 @@ class Mailbox(models.Model):
                 <br />
                 Be sure to urlencode your username and password should they 
                 contain illegal characters (like @, :, etc).
-                """
+                """,
+            blank=True,
+            null=True,
+            default=None,
             )
 
     @property
@@ -61,7 +64,9 @@ class Mailbox(models.Model):
         return '+ssl' in self._protocol_info.scheme.lower()
 
     def get_connection(self):
-        if self.type == 'imap':
+        if not self.uri:
+            return None
+        elif self.type == 'imap':
             conn = ImapTransport(
                         self.location,
                         port=self.port if self.port else None,
@@ -87,19 +92,25 @@ class Mailbox(models.Model):
             conn = MMDFTransport(self.location)
         return conn
 
+    def process_incoming_message(self, message):
+        msg = Message()
+        msg.mailbox = self
+        msg.subject = message['subject'][0:255]
+        msg.message_id = message['message-id'][0:255]
+        msg.from_address = rfc822.parseaddr(message['from'])[1][0:255]
+        msg.body = message.as_string()
+        msg.save()
+        message_received.send(sender=self, message=msg)
+        return msg
+
     def get_new_mail(self):
-        connection = self.get_connection()
         new_mail = []
+        connection = self.get_connection()
+        if not connection:
+            return new_mail
         for message in connection.get_message():
-            msg = Message()
-            msg.mailbox = self
-            msg.subject = message['subject'][0:255]
-            msg.message_id = message['message-id'][0:255]
-            msg.from_address = rfc822.parseaddr(message['from'])[1][0:255]
-            msg.body = message.as_string()
-            msg.save()
+            msg = self.process_incoming_message(message)
             new_mail.append(msg)
-            message_received.send(sender=self, message=msg)
         return new_mail
 
     def __unicode__(self):

readme.rst

@@ -1,7 +1,7 @@
 Introduction
 ~~~~~~~~~~~~
 
-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.
+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).
 
@@ -26,16 +26,16 @@ You can either install from pip::
     cd django-mailbox
     python setup.py install
 
-Setting up your mailbox
-=======================
+Polling for mail in POP3/IMAP or a local mailbox
+================================================
 
-Django Mailbox supports both common internet mailboxes like POP3 and IMAP as well as local file-based mailboxes.
+Django Mailbox supports both common internet mailboxes like POP3 and IMAP, local file-based mailboxes, as well as direct pipe-based delivery.
 
 .. table:: 'Protocol' Options
 
-  ============ ============== =========================================
+  ============ ============== ====================================================
   Mailbox Type 'Protocol'://  Notes
-  ============ ============== =========================================
+  ============ ============== ====================================================
   POP3         ``pop3://``    Can also specify SSL with ``pop3+ssl://``
   IMAP         ``imap://``    Can also specify SSL with ``imap+ssl://``
   Maildir      ``maildir://``
@@ -43,7 +43,8 @@ Django Mailbox supports both common internet mailboxes like POP3 and IMAP as wel
   Babyl        ``babyl://``
   MH           ``mh://``
   MMDF         ``mmdf://``
-  ============ ============== =========================================
+  Piped Mail   *empty*        For pipe-based mailboxes, no URI should be specified
+  ============ ============== ====================================================
 
 POP3 and IMAP Mailboxes
 -----------------------
@@ -71,6 +72,62 @@ If you happen to want to consume a file-based mailbox like an Maildir, Mbox, Bab
 
 Note that there is an additional ``/`` in the above URI after the protocol; this is important.
 
+Getting incoming mail
+---------------------
+
+In your code
+............
+
+Mailbox instances have a method named ``get_new_mail``; this method will gather new messages from the server.
+
+Using the Django Admin
+......................
+
+Check the box next to each of the mailboxes you'd like to fetch e-mail from, and select the 'Get new mail' option.
+
+Using a cron job
+................
+
+You can easily consume incoming mail by running the management command named ``getmail`` (optionally with an argument of the name of the mailbox you'd like to get the mail for).::
+
+    python manage.py getmail
+
+Receiving mail directly from EXIM4 or Postfix via a pipe
+========================================================
+
+Django Mailbox's ``processincomingmessage`` management command accespts, via ``stdin``, incoming messages.  You can configure Postfix or Exim4 to pipe incoming mail to this management command to import messages directly without polling.
+
+Receiving Mail from Exim4
+-------------------------
+
+You should add a new router configuration to your Exim4 configuration like::
+
+  django_mailbox:
+    debug_print = 'R: django_mailbox for $localpart@$domain'
+    driver = accept
+    domains = +local_domains
+    transport = send_to_django_mailbox
+    local_parts = emailusernameone : emailusernametwo
+
+You will want to make sure that the e-mail addresses you would like handled by Django Mailbox are not handled by another router, so you may need to disable some existing routers.  Also, be sure to change the contents of ``local_parts`` to match a colon-delimited list of usernames for which you would like to receive mail for.  For example, if one of the e-mail addresses targeted at this machine is ``jane@example.com``, the contents of ``local_parts`` would be, simply ``jane``.
+
+You should also add a new transport configuration to your Exim4 configuration::
+
+  send_to_django_mailbox:
+    driver = pipe
+    command = /path/to/your/environments/python /path/to/your/projects/manage.py processincomingmessage
+    user = www-data
+    group = www-data
+    return_path_add
+    delivery_date_add
+
+Like your router configuration, you will need to alter this transport configuration.  First, you will want to modify the ``command`` setting such that it points at the proper python binary (if you're using a virtual environment, you'll want to direct that at the python binary in your virtual environment) and project ``manage.py`` script.  Additionally, you'll need to set ``user`` and ``group`` such that they match a reasonable user and group (on Ubuntu, ``www-data`` suffices for both).
+
+Receiving mail from Postfix
+---------------------------
+
+Although I have not personally tried using Postfix for this, Postfix is capable of delivering new mail to a script using ``pipe``.  Please consult the `Postfix documentation for pipe here <http://www.postfix.org/pipe.8.html>`_.  You may want to consult the above Exim4 configuration for tips.
+
 Subscribing to the incoming mail signal
 =======================================
 
@@ -83,26 +140,6 @@ To subscribe to the incoming mail signal, following this lead::
     def dance_jig(sender, message, **args):
         print "I just recieved a message titled %s from a mailbox named %s" % (message.subject, message.mailbox.name, )
 
-Getting incoming mail
-=======================
-
-In your code
-------------
-
-Mailbox instances have a method named ``get_new_mail``; this method will gather new messages from the server.
-
-Using the Django Admin
-----------------------
-
-Check the box next to each of the mailboxes you'd like to fetch e-mail from, and select the 'Get new mail' option.
-
-Using a cron job
-----------------
-
-You can easily consume incoming mail by running the management command named ``getmail`` (optionally with an argument of the name of the mailbox you'd like to get the mail for).::
-
-    python manage.py getmail
-
 Settings
 ========