django-mailbox / django_mailbox /

import email
import rfc822
import urllib
import urlparse

from django.db import models
from django_mailbox.transports import Pop3Transport, ImapTransport,\
        MaildirTransport, MboxTransport, BabylTransport, MHTransport, \
from django_mailbox.signals import message_received

class Mailbox(models.Model):
    name = models.CharField(max_length=255)
    uri = models.CharField(
                Example: imap+ssl://myusername:mypassword@someserver
                <br />
                <br />
                Internet transports include 'imap' and 'pop3'; common local file transports include 'maildir', 'mbox', and less commonly 'babyl', 'mh', and 'mmdf'.
                <br />
                <br />
                Be sure to urlencode your username and password should they 
                contain illegal characters (like @, :, etc).

    def _protocol_info(self):
        return urlparse.urlparse(self.uri)

    def _domain(self):
        return self._protocol_info.hostname

    def port(self):
        return self._protocol_info.port

    def username(self):
        return urllib.unquote(self._protocol_info.username)

    def password(self):
        return urllib.unquote(self._protocol_info.password)

    def location(self):
        return self._domain if self._domain else '' + self._protocol_info.path

    def type(self):
        scheme = self._protocol_info.scheme.lower()
        if '+' in scheme:
            return scheme.split('+')[0]
        return scheme

    def use_ssl(self):
        return '+ssl' in self._protocol_info.scheme.lower()

    def get_connection(self):
        if self.type == 'imap':
            conn = ImapTransport(
                        port=self.port if self.port else None,
            conn.connect(self.username, self.password)
        elif self.type == 'pop3':
            conn = Pop3Transport(
                        port=self.port if self.port else None,
            conn.connect(self.username, self.password)
        elif self.type == 'maildir':
            conn = MaildirTransport(self.location)
        elif self.type == 'mbox':
            conn = MboxTransport(self.location)
        elif self.type == 'babyl':
            conn = BabylTransport(self.location)
        elif self.type == 'mh':
            conn = MHTransport(self.location)
        elif self.type == 'mmdf':
            conn = MMDFTransport(self.location)
        return conn

    def get_new_mail(self):
        connection = self.get_connection()
        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()
            message_received.send(sender=self, message=msg)
        return new_mail

    def __unicode__(self):

    class Meta:
        verbose_name_plural = "Mailboxes"

class Message(models.Model):
    mailbox = models.ForeignKey(Mailbox, related_name='messages')
    subject = models.CharField(max_length=255)
    message_id = models.CharField(max_length=255)
    from_address = models.CharField(max_length=255)

    body = models.TextField()

    received = models.DateTimeField(

    def get_email_object(self):
        return email.message_from_string(self.body)

    def __unicode__(self):
        return self.subject
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.