+++ /dev/null
-#! /usr/bin/env python\r
-\r
-"""Read/write support for Maildir, mbox, MH, Babyl, and MMDF mailboxes."""\r
-\r
-# Notes for authors of new mailbox subclasses:\r
-#\r
-# Remember to fsync() changes to disk before closing a modified file\r
-# or returning from a flush() method. See functions _sync_flush() and\r
-# _sync_close().\r
-\r
-import sys\r
-import os\r
-import time\r
-import calendar\r
-import socket\r
-import errno\r
-import copy\r
-import email\r
-import email.message\r
-import email.generator\r
-import StringIO\r
-try:\r
- if sys.platform == 'os2emx':\r
- # OS/2 EMX fcntl() not adequate\r
- raise ImportError\r
- import fcntl\r
-except ImportError:\r
- fcntl = None\r
-\r
-import warnings\r
-with warnings.catch_warnings():\r
- if sys.py3kwarning:\r
- warnings.filterwarnings("ignore", ".*rfc822 has been removed",\r
- DeprecationWarning)\r
- import rfc822\r
-\r
-__all__ = [ 'Mailbox', 'Maildir', 'mbox', 'MH', 'Babyl', 'MMDF',\r
- 'Message', 'MaildirMessage', 'mboxMessage', 'MHMessage',\r
- 'BabylMessage', 'MMDFMessage', 'UnixMailbox',\r
- 'PortableUnixMailbox', 'MmdfMailbox', 'MHMailbox', 'BabylMailbox' ]\r
-\r
-class Mailbox:\r
- """A group of messages in a particular place."""\r
-\r
- def __init__(self, path, factory=None, create=True):\r
- """Initialize a Mailbox instance."""\r
- self._path = os.path.abspath(os.path.expanduser(path))\r
- self._factory = factory\r
-\r
- def add(self, message):\r
- """Add message and return assigned key."""\r
- raise NotImplementedError('Method must be implemented by subclass')\r
-\r
- def remove(self, key):\r
- """Remove the keyed message; raise KeyError if it doesn't exist."""\r
- raise NotImplementedError('Method must be implemented by subclass')\r
-\r
- def __delitem__(self, key):\r
- self.remove(key)\r
-\r
- def discard(self, key):\r
- """If the keyed message exists, remove it."""\r
- try:\r
- self.remove(key)\r
- except KeyError:\r
- pass\r
-\r
- def __setitem__(self, key, message):\r
- """Replace the keyed message; raise KeyError if it doesn't exist."""\r
- raise NotImplementedError('Method must be implemented by subclass')\r
-\r
- def get(self, key, default=None):\r
- """Return the keyed message, or default if it doesn't exist."""\r
- try:\r
- return self.__getitem__(key)\r
- except KeyError:\r
- return default\r
-\r
- def __getitem__(self, key):\r
- """Return the keyed message; raise KeyError if it doesn't exist."""\r
- if not self._factory:\r
- return self.get_message(key)\r
- else:\r
- return self._factory(self.get_file(key))\r
-\r
- def get_message(self, key):\r
- """Return a Message representation or raise a KeyError."""\r
- raise NotImplementedError('Method must be implemented by subclass')\r
-\r
- def get_string(self, key):\r
- """Return a string representation or raise a KeyError."""\r
- raise NotImplementedError('Method must be implemented by subclass')\r
-\r
- def get_file(self, key):\r
- """Return a file-like representation or raise a KeyError."""\r
- raise NotImplementedError('Method must be implemented by subclass')\r
-\r
- def iterkeys(self):\r
- """Return an iterator over keys."""\r
- raise NotImplementedError('Method must be implemented by subclass')\r
-\r
- def keys(self):\r
- """Return a list of keys."""\r
- return list(self.iterkeys())\r
-\r
- def itervalues(self):\r
- """Return an iterator over all messages."""\r
- for key in self.iterkeys():\r
- try:\r
- value = self[key]\r
- except KeyError:\r
- continue\r
- yield value\r
-\r
- def __iter__(self):\r
- return self.itervalues()\r
-\r
- def values(self):\r
- """Return a list of messages. Memory intensive."""\r
- return list(self.itervalues())\r
-\r
- def iteritems(self):\r
- """Return an iterator over (key, message) tuples."""\r
- for key in self.iterkeys():\r
- try:\r
- value = self[key]\r
- except KeyError:\r
- continue\r
- yield (key, value)\r
-\r
- def items(self):\r
- """Return a list of (key, message) tuples. Memory intensive."""\r
- return list(self.iteritems())\r
-\r
- def has_key(self, key):\r
- """Return True if the keyed message exists, False otherwise."""\r
- raise NotImplementedError('Method must be implemented by subclass')\r
-\r
- def __contains__(self, key):\r
- return self.has_key(key)\r
-\r
- def __len__(self):\r
- """Return a count of messages in the mailbox."""\r
- raise NotImplementedError('Method must be implemented by subclass')\r
-\r
- def clear(self):\r
- """Delete all messages."""\r
- for key in self.iterkeys():\r
- self.discard(key)\r
-\r
- def pop(self, key, default=None):\r
- """Delete the keyed message and return it, or default."""\r
- try:\r
- result = self[key]\r
- except KeyError:\r
- return default\r
- self.discard(key)\r
- return result\r
-\r
- def popitem(self):\r
- """Delete an arbitrary (key, message) pair and return it."""\r
- for key in self.iterkeys():\r
- return (key, self.pop(key)) # This is only run once.\r
- else:\r
- raise KeyError('No messages in mailbox')\r
-\r
- def update(self, arg=None):\r
- """Change the messages that correspond to certain keys."""\r
- if hasattr(arg, 'iteritems'):\r
- source = arg.iteritems()\r
- elif hasattr(arg, 'items'):\r
- source = arg.items()\r
- else:\r
- source = arg\r
- bad_key = False\r
- for key, message in source:\r
- try:\r
- self[key] = message\r
- except KeyError:\r
- bad_key = True\r
- if bad_key:\r
- raise KeyError('No message with key(s)')\r
-\r
- def flush(self):\r
- """Write any pending changes to the disk."""\r
- raise NotImplementedError('Method must be implemented by subclass')\r
-\r
- def lock(self):\r
- """Lock the mailbox."""\r
- raise NotImplementedError('Method must be implemented by subclass')\r
-\r
- def unlock(self):\r
- """Unlock the mailbox if it is locked."""\r
- raise NotImplementedError('Method must be implemented by subclass')\r
-\r
- def close(self):\r
- """Flush and close the mailbox."""\r
- raise NotImplementedError('Method must be implemented by subclass')\r
-\r
- def _dump_message(self, message, target, mangle_from_=False):\r
- # Most files are opened in binary mode to allow predictable seeking.\r
- # To get native line endings on disk, the user-friendly \n line endings\r
- # used in strings and by email.Message are translated here.\r
- """Dump message contents to target file."""\r
- if isinstance(message, email.message.Message):\r
- buffer = StringIO.StringIO()\r
- gen = email.generator.Generator(buffer, mangle_from_, 0)\r
- gen.flatten(message)\r
- buffer.seek(0)\r
- target.write(buffer.read().replace('\n', os.linesep))\r
- elif isinstance(message, str):\r
- if mangle_from_:\r
- message = message.replace('\nFrom ', '\n>From ')\r
- message = message.replace('\n', os.linesep)\r
- target.write(message)\r
- elif hasattr(message, 'read'):\r
- while True:\r
- line = message.readline()\r
- if line == '':\r
- break\r
- if mangle_from_ and line.startswith('From '):\r
- line = '>From ' + line[5:]\r
- line = line.replace('\n', os.linesep)\r
- target.write(line)\r
- else:\r
- raise TypeError('Invalid message type: %s' % type(message))\r
-\r
-\r
-class Maildir(Mailbox):\r
- """A qmail-style Maildir mailbox."""\r
-\r
- colon = ':'\r
-\r
- def __init__(self, dirname, factory=rfc822.Message, create=True):\r
- """Initialize a Maildir instance."""\r
- Mailbox.__init__(self, dirname, factory, create)\r
- self._paths = {\r
- 'tmp': os.path.join(self._path, 'tmp'),\r
- 'new': os.path.join(self._path, 'new'),\r
- 'cur': os.path.join(self._path, 'cur'),\r
- }\r
- if not os.path.exists(self._path):\r
- if create:\r
- os.mkdir(self._path, 0700)\r
- for path in self._paths.values():\r
- os.mkdir(path, 0o700)\r
- else:\r
- raise NoSuchMailboxError(self._path)\r
- self._toc = {}\r
- self._toc_mtimes = {}\r
- for subdir in ('cur', 'new'):\r
- self._toc_mtimes[subdir] = os.path.getmtime(self._paths[subdir])\r
- self._last_read = time.time() # Records last time we read cur/new\r
- self._skewfactor = 0.1 # Adjust if os/fs clocks are skewing\r
-\r
- def add(self, message):\r
- """Add message and return assigned key."""\r
- tmp_file = self._create_tmp()\r
- try:\r
- self._dump_message(message, tmp_file)\r
- except BaseException:\r
- tmp_file.close()\r
- os.remove(tmp_file.name)\r
- raise\r
- _sync_close(tmp_file)\r
- if isinstance(message, MaildirMessage):\r
- subdir = message.get_subdir()\r
- suffix = self.colon + message.get_info()\r
- if suffix == self.colon:\r
- suffix = ''\r
- else:\r
- subdir = 'new'\r
- suffix = ''\r
- uniq = os.path.basename(tmp_file.name).split(self.colon)[0]\r
- dest = os.path.join(self._path, subdir, uniq + suffix)\r
- try:\r
- if hasattr(os, 'link'):\r
- os.link(tmp_file.name, dest)\r
- os.remove(tmp_file.name)\r
- else:\r
- os.rename(tmp_file.name, dest)\r
- except OSError, e:\r
- os.remove(tmp_file.name)\r
- if e.errno == errno.EEXIST:\r
- raise ExternalClashError('Name clash with existing message: %s'\r
- % dest)\r
- else:\r
- raise\r
- if isinstance(message, MaildirMessage):\r
- os.utime(dest, (os.path.getatime(dest), message.get_date()))\r
- return uniq\r
-\r
- def remove(self, key):\r
- """Remove the keyed message; raise KeyError if it doesn't exist."""\r
- os.remove(os.path.join(self._path, self._lookup(key)))\r
-\r
- def discard(self, key):\r
- """If the keyed message exists, remove it."""\r
- # This overrides an inapplicable implementation in the superclass.\r
- try:\r
- self.remove(key)\r
- except KeyError:\r
- pass\r
- except OSError, e:\r
- if e.errno != errno.ENOENT:\r
- raise\r
-\r
- def __setitem__(self, key, message):\r
- """Replace the keyed message; raise KeyError if it doesn't exist."""\r
- old_subpath = self._lookup(key)\r
- temp_key = self.add(message)\r
- temp_subpath = self._lookup(temp_key)\r
- if isinstance(message, MaildirMessage):\r
- # temp's subdir and suffix were specified by message.\r
- dominant_subpath = temp_subpath\r
- else:\r
- # temp's subdir and suffix were defaults from add().\r
- dominant_subpath = old_subpath\r
- subdir = os.path.dirname(dominant_subpath)\r
- if self.colon in dominant_subpath:\r
- suffix = self.colon + dominant_subpath.split(self.colon)[-1]\r
- else:\r
- suffix = ''\r
- self.discard(key)\r
- new_path = os.path.join(self._path, subdir, key + suffix)\r
- os.rename(os.path.join(self._path, temp_subpath), new_path)\r
- if isinstance(message, MaildirMessage):\r
- os.utime(new_path, (os.path.getatime(new_path),\r
- message.get_date()))\r
-\r
- def get_message(self, key):\r
- """Return a Message representation or raise a KeyError."""\r
- subpath = self._lookup(key)\r
- f = open(os.path.join(self._path, subpath), 'r')\r
- try:\r
- if self._factory:\r
- msg = self._factory(f)\r
- else:\r
- msg = MaildirMessage(f)\r
- finally:\r
- f.close()\r
- subdir, name = os.path.split(subpath)\r
- msg.set_subdir(subdir)\r
- if self.colon in name:\r
- msg.set_info(name.split(self.colon)[-1])\r
- msg.set_date(os.path.getmtime(os.path.join(self._path, subpath)))\r
- return msg\r
-\r
- def get_string(self, key):\r
- """Return a string representation or raise a KeyError."""\r
- f = open(os.path.join(self._path, self._lookup(key)), 'r')\r
- try:\r
- return f.read()\r
- finally:\r
- f.close()\r
-\r
- def get_file(self, key):\r
- """Return a file-like representation or raise a KeyError."""\r
- f = open(os.path.join(self._path, self._lookup(key)), 'rb')\r
- return _ProxyFile(f)\r
-\r
- def iterkeys(self):\r
- """Return an iterator over keys."""\r
- self._refresh()\r
- for key in self._toc:\r
- try:\r
- self._lookup(key)\r
- except KeyError:\r
- continue\r
- yield key\r
-\r
- def has_key(self, key):\r
- """Return True if the keyed message exists, False otherwise."""\r
- self._refresh()\r
- return key in self._toc\r
-\r
- def __len__(self):\r
- """Return a count of messages in the mailbox."""\r
- self._refresh()\r
- return len(self._toc)\r
-\r
- def flush(self):\r
- """Write any pending changes to disk."""\r
- # Maildir changes are always written immediately, so there's nothing\r
- # to do.\r
- pass\r
-\r
- def lock(self):\r
- """Lock the mailbox."""\r
- return\r
-\r
- def unlock(self):\r
- """Unlock the mailbox if it is locked."""\r
- return\r
-\r
- def close(self):\r
- """Flush and close the mailbox."""\r
- return\r
-\r
- def list_folders(self):\r
- """Return a list of folder names."""\r
- result = []\r
- for entry in os.listdir(self._path):\r
- if len(entry) > 1 and entry[0] == '.' and \\r
- os.path.isdir(os.path.join(self._path, entry)):\r
- result.append(entry[1:])\r
- return result\r
-\r
- def get_folder(self, folder):\r
- """Return a Maildir instance for the named folder."""\r
- return Maildir(os.path.join(self._path, '.' + folder),\r
- factory=self._factory,\r
- create=False)\r
-\r
- def add_folder(self, folder):\r
- """Create a folder and return a Maildir instance representing it."""\r
- path = os.path.join(self._path, '.' + folder)\r
- result = Maildir(path, factory=self._factory)\r
- maildirfolder_path = os.path.join(path, 'maildirfolder')\r
- if not os.path.exists(maildirfolder_path):\r
- os.close(os.open(maildirfolder_path, os.O_CREAT | os.O_WRONLY,\r
- 0666))\r
- return result\r
-\r
- def remove_folder(self, folder):\r
- """Delete the named folder, which must be empty."""\r
- path = os.path.join(self._path, '.' + folder)\r
- for entry in os.listdir(os.path.join(path, 'new')) + \\r
- os.listdir(os.path.join(path, 'cur')):\r
- if len(entry) < 1 or entry[0] != '.':\r
- raise NotEmptyError('Folder contains message(s): %s' % folder)\r
- for entry in os.listdir(path):\r
- if entry != 'new' and entry != 'cur' and entry != 'tmp' and \\r
- os.path.isdir(os.path.join(path, entry)):\r
- raise NotEmptyError("Folder contains subdirectory '%s': %s" %\r
- (folder, entry))\r
- for root, dirs, files in os.walk(path, topdown=False):\r
- for entry in files:\r
- os.remove(os.path.join(root, entry))\r
- for entry in dirs:\r
- os.rmdir(os.path.join(root, entry))\r
- os.rmdir(path)\r
-\r
- def clean(self):\r
- """Delete old files in "tmp"."""\r
- now = time.time()\r
- for entry in os.listdir(os.path.join(self._path, 'tmp')):\r
- path = os.path.join(self._path, 'tmp', entry)\r
- if now - os.path.getatime(path) > 129600: # 60 * 60 * 36\r
- os.remove(path)\r
-\r
- _count = 1 # This is used to generate unique file names.\r
-\r
- def _create_tmp(self):\r
- """Create a file in the tmp subdirectory and open and return it."""\r
- now = time.time()\r
- hostname = socket.gethostname()\r
- if '/' in hostname:\r
- hostname = hostname.replace('/', r'\057')\r
- if ':' in hostname:\r
- hostname = hostname.replace(':', r'\072')\r
- uniq = "%s.M%sP%sQ%s.%s" % (int(now), int(now % 1 * 1e6), os.getpid(),\r
- Maildir._count, hostname)\r
- path = os.path.join(self._path, 'tmp', uniq)\r
- try:\r
- os.stat(path)\r
- except OSError, e:\r
- if e.errno == errno.ENOENT:\r
- Maildir._count += 1\r
- try:\r
- return _create_carefully(path)\r
- except OSError, e:\r
- if e.errno != errno.EEXIST:\r
- raise\r
- else:\r
- raise\r
-\r
- # Fall through to here if stat succeeded or open raised EEXIST.\r
- raise ExternalClashError('Name clash prevented file creation: %s' %\r
- path)\r
-\r
- def _refresh(self):\r
- """Update table of contents mapping."""\r
- # If it has been less than two seconds since the last _refresh() call,\r
- # we have to unconditionally re-read the mailbox just in case it has\r
- # been modified, because os.path.mtime() has a 2 sec resolution in the\r
- # most common worst case (FAT) and a 1 sec resolution typically. This\r
- # results in a few unnecessary re-reads when _refresh() is called\r
- # multiple times in that interval, but once the clock ticks over, we\r
- # will only re-read as needed. Because the filesystem might be being\r
- # served by an independent system with its own clock, we record and\r
- # compare with the mtimes from the filesystem. Because the other\r
- # system's clock might be skewing relative to our clock, we add an\r
- # extra delta to our wait. The default is one tenth second, but is an\r
- # instance variable and so can be adjusted if dealing with a\r
- # particularly skewed or irregular system.\r
- if time.time() - self._last_read > 2 + self._skewfactor:\r
- refresh = False\r
- for subdir in self._toc_mtimes:\r
- mtime = os.path.getmtime(self._paths[subdir])\r
- if mtime > self._toc_mtimes[subdir]:\r
- refresh = True\r
- self._toc_mtimes[subdir] = mtime\r
- if not refresh:\r
- return\r
- # Refresh toc\r
- self._toc = {}\r
- for subdir in self._toc_mtimes:\r
- path = self._paths[subdir]\r
- for entry in os.listdir(path):\r
- p = os.path.join(path, entry)\r
- if os.path.isdir(p):\r
- continue\r
- uniq = entry.split(self.colon)[0]\r
- self._toc[uniq] = os.path.join(subdir, entry)\r
- self._last_read = time.time()\r
-\r
- def _lookup(self, key):\r
- """Use TOC to return subpath for given key, or raise a KeyError."""\r
- try:\r
- if os.path.exists(os.path.join(self._path, self._toc[key])):\r
- return self._toc[key]\r
- except KeyError:\r
- pass\r
- self._refresh()\r
- try:\r
- return self._toc[key]\r
- except KeyError:\r
- raise KeyError('No message with key: %s' % key)\r
-\r
- # This method is for backward compatibility only.\r
- def next(self):\r
- """Return the next message in a one-time iteration."""\r
- if not hasattr(self, '_onetime_keys'):\r
- self._onetime_keys = self.iterkeys()\r
- while True:\r
- try:\r
- return self[self._onetime_keys.next()]\r
- except StopIteration:\r
- return None\r
- except KeyError:\r
- continue\r
-\r
-\r
-class _singlefileMailbox(Mailbox):\r
- """A single-file mailbox."""\r
-\r
- def __init__(self, path, factory=None, create=True):\r
- """Initialize a single-file mailbox."""\r
- Mailbox.__init__(self, path, factory, create)\r
- try:\r
- f = open(self._path, 'rb+')\r
- except IOError, e:\r
- if e.errno == errno.ENOENT:\r
- if create:\r
- f = open(self._path, 'wb+')\r
- else:\r
- raise NoSuchMailboxError(self._path)\r
- elif e.errno in (errno.EACCES, errno.EROFS):\r
- f = open(self._path, 'rb')\r
- else:\r
- raise\r
- self._file = f\r
- self._toc = None\r
- self._next_key = 0\r
- self._pending = False # No changes require rewriting the file.\r
- self._locked = False\r
- self._file_length = None # Used to record mailbox size\r
-\r
- def add(self, message):\r
- """Add message and return assigned key."""\r
- self._lookup()\r
- self._toc[self._next_key] = self._append_message(message)\r
- self._next_key += 1\r
- self._pending = True\r
- return self._next_key - 1\r
-\r
- def remove(self, key):\r
- """Remove the keyed message; raise KeyError if it doesn't exist."""\r
- self._lookup(key)\r
- del self._toc[key]\r
- self._pending = True\r
-\r
- def __setitem__(self, key, message):\r
- """Replace the keyed message; raise KeyError if it doesn't exist."""\r
- self._lookup(key)\r
- self._toc[key] = self._append_message(message)\r
- self._pending = True\r
-\r
- def iterkeys(self):\r
- """Return an iterator over keys."""\r
- self._lookup()\r
- for key in self._toc.keys():\r
- yield key\r
-\r
- def has_key(self, key):\r
- """Return True if the keyed message exists, False otherwise."""\r
- self._lookup()\r
- return key in self._toc\r
-\r
- def __len__(self):\r
- """Return a count of messages in the mailbox."""\r
- self._lookup()\r
- return len(self._toc)\r
-\r
- def lock(self):\r
- """Lock the mailbox."""\r
- if not self._locked:\r
- _lock_file(self._file)\r
- self._locked = True\r
-\r
- def unlock(self):\r
- """Unlock the mailbox if it is locked."""\r
- if self._locked:\r
- _unlock_file(self._file)\r
- self._locked = False\r
-\r
- def flush(self):\r
- """Write any pending changes to disk."""\r
- if not self._pending:\r
- return\r
-\r
- # In order to be writing anything out at all, self._toc must\r
- # already have been generated (and presumably has been modified\r
- # by adding or deleting an item).\r
- assert self._toc is not None\r
-\r
- # Check length of self._file; if it's changed, some other process\r
- # has modified the mailbox since we scanned it.\r
- self._file.seek(0, 2)\r
- cur_len = self._file.tell()\r
- if cur_len != self._file_length:\r
- raise ExternalClashError('Size of mailbox file changed '\r
- '(expected %i, found %i)' %\r
- (self._file_length, cur_len))\r
-\r
- new_file = _create_temporary(self._path)\r
- try:\r
- new_toc = {}\r
- self._pre_mailbox_hook(new_file)\r
- for key in sorted(self._toc.keys()):\r
- start, stop = self._toc[key]\r
- self._file.seek(start)\r
- self._pre_message_hook(new_file)\r
- new_start = new_file.tell()\r
- while True:\r
- buffer = self._file.read(min(4096,\r
- stop - self._file.tell()))\r
- if buffer == '':\r
- break\r
- new_file.write(buffer)\r
- new_toc[key] = (new_start, new_file.tell())\r
- self._post_message_hook(new_file)\r
- except:\r
- new_file.close()\r
- os.remove(new_file.name)\r
- raise\r
- _sync_close(new_file)\r
- # self._file is about to get replaced, so no need to sync.\r
- self._file.close()\r
- try:\r
- os.rename(new_file.name, self._path)\r
- except OSError, e:\r
- if e.errno == errno.EEXIST or \\r
- (os.name == 'os2' and e.errno == errno.EACCES):\r
- os.remove(self._path)\r
- os.rename(new_file.name, self._path)\r
- else:\r
- raise\r
- self._file = open(self._path, 'rb+')\r
- self._toc = new_toc\r
- self._pending = False\r
- if self._locked:\r
- _lock_file(self._file, dotlock=False)\r
-\r
- def _pre_mailbox_hook(self, f):\r
- """Called before writing the mailbox to file f."""\r
- return\r
-\r
- def _pre_message_hook(self, f):\r
- """Called before writing each message to file f."""\r
- return\r
-\r
- def _post_message_hook(self, f):\r
- """Called after writing each message to file f."""\r
- return\r
-\r
- def close(self):\r
- """Flush and close the mailbox."""\r
- self.flush()\r
- if self._locked:\r
- self.unlock()\r
- self._file.close() # Sync has been done by self.flush() above.\r
-\r
- def _lookup(self, key=None):\r
- """Return (start, stop) or raise KeyError."""\r
- if self._toc is None:\r
- self._generate_toc()\r
- if key is not None:\r
- try:\r
- return self._toc[key]\r
- except KeyError:\r
- raise KeyError('No message with key: %s' % key)\r
-\r
- def _append_message(self, message):\r
- """Append message to mailbox and return (start, stop) offsets."""\r
- self._file.seek(0, 2)\r
- before = self._file.tell()\r
- try:\r
- self._pre_message_hook(self._file)\r
- offsets = self._install_message(message)\r
- self._post_message_hook(self._file)\r
- except BaseException:\r
- self._file.truncate(before)\r
- raise\r
- self._file.flush()\r
- self._file_length = self._file.tell() # Record current length of mailbox\r
- return offsets\r
-\r
-\r
-\r
-class _mboxMMDF(_singlefileMailbox):\r
- """An mbox or MMDF mailbox."""\r
-\r
- _mangle_from_ = True\r
-\r
- def get_message(self, key):\r
- """Return a Message representation or raise a KeyError."""\r
- start, stop = self._lookup(key)\r
- self._file.seek(start)\r
- from_line = self._file.readline().replace(os.linesep, '')\r
- string = self._file.read(stop - self._file.tell())\r
- msg = self._message_factory(string.replace(os.linesep, '\n'))\r
- msg.set_from(from_line[5:])\r
- return msg\r
-\r
- def get_string(self, key, from_=False):\r
- """Return a string representation or raise a KeyError."""\r
- start, stop = self._lookup(key)\r
- self._file.seek(start)\r
- if not from_:\r
- self._file.readline()\r
- string = self._file.read(stop - self._file.tell())\r
- return string.replace(os.linesep, '\n')\r
-\r
- def get_file(self, key, from_=False):\r
- """Return a file-like representation or raise a KeyError."""\r
- start, stop = self._lookup(key)\r
- self._file.seek(start)\r
- if not from_:\r
- self._file.readline()\r
- return _PartialFile(self._file, self._file.tell(), stop)\r
-\r
- def _install_message(self, message):\r
- """Format a message and blindly write to self._file."""\r
- from_line = None\r
- if isinstance(message, str) and message.startswith('From '):\r
- newline = message.find('\n')\r
- if newline != -1:\r
- from_line = message[:newline]\r
- message = message[newline + 1:]\r
- else:\r
- from_line = message\r
- message = ''\r
- elif isinstance(message, _mboxMMDFMessage):\r
- from_line = 'From ' + message.get_from()\r
- elif isinstance(message, email.message.Message):\r
- from_line = message.get_unixfrom() # May be None.\r
- if from_line is None:\r
- from_line = 'From MAILER-DAEMON %s' % time.asctime(time.gmtime())\r
- start = self._file.tell()\r
- self._file.write(from_line + os.linesep)\r
- self._dump_message(message, self._file, self._mangle_from_)\r
- stop = self._file.tell()\r
- return (start, stop)\r
-\r
-\r
-class mbox(_mboxMMDF):\r
- """A classic mbox mailbox."""\r
-\r
- _mangle_from_ = True\r
-\r
- def __init__(self, path, factory=None, create=True):\r
- """Initialize an mbox mailbox."""\r
- self._message_factory = mboxMessage\r
- _mboxMMDF.__init__(self, path, factory, create)\r
-\r
- def _pre_message_hook(self, f):\r
- """Called before writing each message to file f."""\r
- if f.tell() != 0:\r
- f.write(os.linesep)\r
-\r
- def _generate_toc(self):\r
- """Generate key-to-(start, stop) table of contents."""\r
- starts, stops = [], []\r
- self._file.seek(0)\r
- while True:\r
- line_pos = self._file.tell()\r
- line = self._file.readline()\r
- if line.startswith('From '):\r
- if len(stops) < len(starts):\r
- stops.append(line_pos - len(os.linesep))\r
- starts.append(line_pos)\r
- elif line == '':\r
- stops.append(line_pos)\r
- break\r
- self._toc = dict(enumerate(zip(starts, stops)))\r
- self._next_key = len(self._toc)\r
- self._file_length = self._file.tell()\r
-\r
-\r
-class MMDF(_mboxMMDF):\r
- """An MMDF mailbox."""\r
-\r
- def __init__(self, path, factory=None, create=True):\r
- """Initialize an MMDF mailbox."""\r
- self._message_factory = MMDFMessage\r
- _mboxMMDF.__init__(self, path, factory, create)\r
-\r
- def _pre_message_hook(self, f):\r
- """Called before writing each message to file f."""\r
- f.write('\001\001\001\001' + os.linesep)\r
-\r
- def _post_message_hook(self, f):\r
- """Called after writing each message to file f."""\r
- f.write(os.linesep + '\001\001\001\001' + os.linesep)\r
-\r
- def _generate_toc(self):\r
- """Generate key-to-(start, stop) table of contents."""\r
- starts, stops = [], []\r
- self._file.seek(0)\r
- next_pos = 0\r
- while True:\r
- line_pos = next_pos\r
- line = self._file.readline()\r
- next_pos = self._file.tell()\r
- if line.startswith('\001\001\001\001' + os.linesep):\r
- starts.append(next_pos)\r
- while True:\r
- line_pos = next_pos\r
- line = self._file.readline()\r
- next_pos = self._file.tell()\r
- if line == '\001\001\001\001' + os.linesep:\r
- stops.append(line_pos - len(os.linesep))\r
- break\r
- elif line == '':\r
- stops.append(line_pos)\r
- break\r
- elif line == '':\r
- break\r
- self._toc = dict(enumerate(zip(starts, stops)))\r
- self._next_key = len(self._toc)\r
- self._file.seek(0, 2)\r
- self._file_length = self._file.tell()\r
-\r
-\r
-class MH(Mailbox):\r
- """An MH mailbox."""\r
-\r
- def __init__(self, path, factory=None, create=True):\r
- """Initialize an MH instance."""\r
- Mailbox.__init__(self, path, factory, create)\r
- if not os.path.exists(self._path):\r
- if create:\r
- os.mkdir(self._path, 0700)\r
- os.close(os.open(os.path.join(self._path, '.mh_sequences'),\r
- os.O_CREAT | os.O_EXCL | os.O_WRONLY, 0600))\r
- else:\r
- raise NoSuchMailboxError(self._path)\r
- self._locked = False\r
-\r
- def add(self, message):\r
- """Add message and return assigned key."""\r
- keys = self.keys()\r
- if len(keys) == 0:\r
- new_key = 1\r
- else:\r
- new_key = max(keys) + 1\r
- new_path = os.path.join(self._path, str(new_key))\r
- f = _create_carefully(new_path)\r
- closed = False\r
- try:\r
- if self._locked:\r
- _lock_file(f)\r
- try:\r
- try:\r
- self._dump_message(message, f)\r
- except BaseException:\r
- # Unlock and close so it can be deleted on Windows\r
- if self._locked:\r
- _unlock_file(f)\r
- _sync_close(f)\r
- closed = True\r
- os.remove(new_path)\r
- raise\r
- if isinstance(message, MHMessage):\r
- self._dump_sequences(message, new_key)\r
- finally:\r
- if self._locked:\r
- _unlock_file(f)\r
- finally:\r
- if not closed:\r
- _sync_close(f)\r
- return new_key\r
-\r
- def remove(self, key):\r
- """Remove the keyed message; raise KeyError if it doesn't exist."""\r
- path = os.path.join(self._path, str(key))\r
- try:\r
- f = open(path, 'rb+')\r
- except IOError, e:\r
- if e.errno == errno.ENOENT:\r
- raise KeyError('No message with key: %s' % key)\r
- else:\r
- raise\r
- else:\r
- f.close()\r
- os.remove(path)\r
-\r
- def __setitem__(self, key, message):\r
- """Replace the keyed message; raise KeyError if it doesn't exist."""\r
- path = os.path.join(self._path, str(key))\r
- try:\r
- f = open(path, 'rb+')\r
- except IOError, e:\r
- if e.errno == errno.ENOENT:\r
- raise KeyError('No message with key: %s' % key)\r
- else:\r
- raise\r
- try:\r
- if self._locked:\r
- _lock_file(f)\r
- try:\r
- os.close(os.open(path, os.O_WRONLY | os.O_TRUNC))\r
- self._dump_message(message, f)\r
- if isinstance(message, MHMessage):\r
- self._dump_sequences(message, key)\r
- finally:\r
- if self._locked:\r
- _unlock_file(f)\r
- finally:\r
- _sync_close(f)\r
-\r
- def get_message(self, key):\r
- """Return a Message representation or raise a KeyError."""\r
- try:\r
- if self._locked:\r
- f = open(os.path.join(self._path, str(key)), 'r+')\r
- else:\r
- f = open(os.path.join(self._path, str(key)), 'r')\r
- except IOError, e:\r
- if e.errno == errno.ENOENT:\r
- raise KeyError('No message with key: %s' % key)\r
- else:\r
- raise\r
- try:\r
- if self._locked:\r
- _lock_file(f)\r
- try:\r
- msg = MHMessage(f)\r
- finally:\r
- if self._locked:\r
- _unlock_file(f)\r
- finally:\r
- f.close()\r
- for name, key_list in self.get_sequences().iteritems():\r
- if key in key_list:\r
- msg.add_sequence(name)\r
- return msg\r
-\r
- def get_string(self, key):\r
- """Return a string representation or raise a KeyError."""\r
- try:\r
- if self._locked:\r
- f = open(os.path.join(self._path, str(key)), 'r+')\r
- else:\r
- f = open(os.path.join(self._path, str(key)), 'r')\r
- except IOError, e:\r
- if e.errno == errno.ENOENT:\r
- raise KeyError('No message with key: %s' % key)\r
- else:\r
- raise\r
- try:\r
- if self._locked:\r
- _lock_file(f)\r
- try:\r
- return f.read()\r
- finally:\r
- if self._locked:\r
- _unlock_file(f)\r
- finally:\r
- f.close()\r
-\r
- def get_file(self, key):\r
- """Return a file-like representation or raise a KeyError."""\r
- try:\r
- f = open(os.path.join(self._path, str(key)), 'rb')\r
- except IOError, e:\r
- if e.errno == errno.ENOENT:\r
- raise KeyError('No message with key: %s' % key)\r
- else:\r
- raise\r
- return _ProxyFile(f)\r
-\r
- def iterkeys(self):\r
- """Return an iterator over keys."""\r
- return iter(sorted(int(entry) for entry in os.listdir(self._path)\r
- if entry.isdigit()))\r
-\r
- def has_key(self, key):\r
- """Return True if the keyed message exists, False otherwise."""\r
- return os.path.exists(os.path.join(self._path, str(key)))\r
-\r
- def __len__(self):\r
- """Return a count of messages in the mailbox."""\r
- return len(list(self.iterkeys()))\r
-\r
- def lock(self):\r
- """Lock the mailbox."""\r
- if not self._locked:\r
- self._file = open(os.path.join(self._path, '.mh_sequences'), 'rb+')\r
- _lock_file(self._file)\r
- self._locked = True\r
-\r
- def unlock(self):\r
- """Unlock the mailbox if it is locked."""\r
- if self._locked:\r
- _unlock_file(self._file)\r
- _sync_close(self._file)\r
- del self._file\r
- self._locked = False\r
-\r
- def flush(self):\r
- """Write any pending changes to the disk."""\r
- return\r
-\r
- def close(self):\r
- """Flush and close the mailbox."""\r
- if self._locked:\r
- self.unlock()\r
-\r
- def list_folders(self):\r
- """Return a list of folder names."""\r
- result = []\r
- for entry in os.listdir(self._path):\r
- if os.path.isdir(os.path.join(self._path, entry)):\r
- result.append(entry)\r
- return result\r
-\r
- def get_folder(self, folder):\r
- """Return an MH instance for the named folder."""\r
- return MH(os.path.join(self._path, folder),\r
- factory=self._factory, create=False)\r
-\r
- def add_folder(self, folder):\r
- """Create a folder and return an MH instance representing it."""\r
- return MH(os.path.join(self._path, folder),\r
- factory=self._factory)\r
-\r
- def remove_folder(self, folder):\r
- """Delete the named folder, which must be empty."""\r
- path = os.path.join(self._path, folder)\r
- entries = os.listdir(path)\r
- if entries == ['.mh_sequences']:\r
- os.remove(os.path.join(path, '.mh_sequences'))\r
- elif entries == []:\r
- pass\r
- else:\r
- raise NotEmptyError('Folder not empty: %s' % self._path)\r
- os.rmdir(path)\r
-\r
- def get_sequences(self):\r
- """Return a name-to-key-list dictionary to define each sequence."""\r
- results = {}\r
- f = open(os.path.join(self._path, '.mh_sequences'), 'r')\r
- try:\r
- all_keys = set(self.keys())\r
- for line in f:\r
- try:\r
- name, contents = line.split(':')\r
- keys = set()\r
- for spec in contents.split():\r
- if spec.isdigit():\r
- keys.add(int(spec))\r
- else:\r
- start, stop = (int(x) for x in spec.split('-'))\r
- keys.update(range(start, stop + 1))\r
- results[name] = [key for key in sorted(keys) \\r
- if key in all_keys]\r
- if len(results[name]) == 0:\r
- del results[name]\r
- except ValueError:\r
- raise FormatError('Invalid sequence specification: %s' %\r
- line.rstrip())\r
- finally:\r
- f.close()\r
- return results\r
-\r
- def set_sequences(self, sequences):\r
- """Set sequences using the given name-to-key-list dictionary."""\r
- f = open(os.path.join(self._path, '.mh_sequences'), 'r+')\r
- try:\r
- os.close(os.open(f.name, os.O_WRONLY | os.O_TRUNC))\r
- for name, keys in sequences.iteritems():\r
- if len(keys) == 0:\r
- continue\r
- f.write('%s:' % name)\r
- prev = None\r
- completing = False\r
- for key in sorted(set(keys)):\r
- if key - 1 == prev:\r
- if not completing:\r
- completing = True\r
- f.write('-')\r
- elif completing:\r
- completing = False\r
- f.write('%s %s' % (prev, key))\r
- else:\r
- f.write(' %s' % key)\r
- prev = key\r
- if completing:\r
- f.write(str(prev) + '\n')\r
- else:\r
- f.write('\n')\r
- finally:\r
- _sync_close(f)\r
-\r
- def pack(self):\r
- """Re-name messages to eliminate numbering gaps. Invalidates keys."""\r
- sequences = self.get_sequences()\r
- prev = 0\r
- changes = []\r
- for key in self.iterkeys():\r
- if key - 1 != prev:\r
- changes.append((key, prev + 1))\r
- if hasattr(os, 'link'):\r
- os.link(os.path.join(self._path, str(key)),\r
- os.path.join(self._path, str(prev + 1)))\r
- os.unlink(os.path.join(self._path, str(key)))\r
- else:\r
- os.rename(os.path.join(self._path, str(key)),\r
- os.path.join(self._path, str(prev + 1)))\r
- prev += 1\r
- self._next_key = prev + 1\r
- if len(changes) == 0:\r
- return\r
- for name, key_list in sequences.items():\r
- for old, new in changes:\r
- if old in key_list:\r
- key_list[key_list.index(old)] = new\r
- self.set_sequences(sequences)\r
-\r
- def _dump_sequences(self, message, key):\r
- """Inspect a new MHMessage and update sequences appropriately."""\r
- pending_sequences = message.get_sequences()\r
- all_sequences = self.get_sequences()\r
- for name, key_list in all_sequences.iteritems():\r
- if name in pending_sequences:\r
- key_list.append(key)\r
- elif key in key_list:\r
- del key_list[key_list.index(key)]\r
- for sequence in pending_sequences:\r
- if sequence not in all_sequences:\r
- all_sequences[sequence] = [key]\r
- self.set_sequences(all_sequences)\r
-\r
-\r
-class Babyl(_singlefileMailbox):\r
- """An Rmail-style Babyl mailbox."""\r
-\r
- _special_labels = frozenset(('unseen', 'deleted', 'filed', 'answered',\r
- 'forwarded', 'edited', 'resent'))\r
-\r
- def __init__(self, path, factory=None, create=True):\r
- """Initialize a Babyl mailbox."""\r
- _singlefileMailbox.__init__(self, path, factory, create)\r
- self._labels = {}\r
-\r
- def add(self, message):\r
- """Add message and return assigned key."""\r
- key = _singlefileMailbox.add(self, message)\r
- if isinstance(message, BabylMessage):\r
- self._labels[key] = message.get_labels()\r
- return key\r
-\r
- def remove(self, key):\r
- """Remove the keyed message; raise KeyError if it doesn't exist."""\r
- _singlefileMailbox.remove(self, key)\r
- if key in self._labels:\r
- del self._labels[key]\r
-\r
- def __setitem__(self, key, message):\r
- """Replace the keyed message; raise KeyError if it doesn't exist."""\r
- _singlefileMailbox.__setitem__(self, key, message)\r
- if isinstance(message, BabylMessage):\r
- self._labels[key] = message.get_labels()\r
-\r
- def get_message(self, key):\r
- """Return a Message representation or raise a KeyError."""\r
- start, stop = self._lookup(key)\r
- self._file.seek(start)\r
- self._file.readline() # Skip '1,' line specifying labels.\r
- original_headers = StringIO.StringIO()\r
- while True:\r
- line = self._file.readline()\r
- if line == '*** EOOH ***' + os.linesep or line == '':\r
- break\r
- original_headers.write(line.replace(os.linesep, '\n'))\r
- visible_headers = StringIO.StringIO()\r
- while True:\r
- line = self._file.readline()\r
- if line == os.linesep or line == '':\r
- break\r
- visible_headers.write(line.replace(os.linesep, '\n'))\r
- body = self._file.read(stop - self._file.tell()).replace(os.linesep,\r
- '\n')\r
- msg = BabylMessage(original_headers.getvalue() + body)\r
- msg.set_visible(visible_headers.getvalue())\r
- if key in self._labels:\r
- msg.set_labels(self._labels[key])\r
- return msg\r
-\r
- def get_string(self, key):\r
- """Return a string representation or raise a KeyError."""\r
- start, stop = self._lookup(key)\r
- self._file.seek(start)\r
- self._file.readline() # Skip '1,' line specifying labels.\r
- original_headers = StringIO.StringIO()\r
- while True:\r
- line = self._file.readline()\r
- if line == '*** EOOH ***' + os.linesep or line == '':\r
- break\r
- original_headers.write(line.replace(os.linesep, '\n'))\r
- while True:\r
- line = self._file.readline()\r
- if line == os.linesep or line == '':\r
- break\r
- return original_headers.getvalue() + \\r
- self._file.read(stop - self._file.tell()).replace(os.linesep,\r
- '\n')\r
-\r
- def get_file(self, key):\r
- """Return a file-like representation or raise a KeyError."""\r
- return StringIO.StringIO(self.get_string(key).replace('\n',\r
- os.linesep))\r
-\r
- def get_labels(self):\r
- """Return a list of user-defined labels in the mailbox."""\r
- self._lookup()\r
- labels = set()\r
- for label_list in self._labels.values():\r
- labels.update(label_list)\r
- labels.difference_update(self._special_labels)\r
- return list(labels)\r
-\r
- def _generate_toc(self):\r
- """Generate key-to-(start, stop) table of contents."""\r
- starts, stops = [], []\r
- self._file.seek(0)\r
- next_pos = 0\r
- label_lists = []\r
- while True:\r
- line_pos = next_pos\r
- line = self._file.readline()\r
- next_pos = self._file.tell()\r
- if line == '\037\014' + os.linesep:\r
- if len(stops) < len(starts):\r
- stops.append(line_pos - len(os.linesep))\r
- starts.append(next_pos)\r
- labels = [label.strip() for label\r
- in self._file.readline()[1:].split(',')\r
- if label.strip() != '']\r
- label_lists.append(labels)\r
- elif line == '\037' or line == '\037' + os.linesep:\r
- if len(stops) < len(starts):\r
- stops.append(line_pos - len(os.linesep))\r
- elif line == '':\r
- stops.append(line_pos - len(os.linesep))\r
- break\r
- self._toc = dict(enumerate(zip(starts, stops)))\r
- self._labels = dict(enumerate(label_lists))\r
- self._next_key = len(self._toc)\r
- self._file.seek(0, 2)\r
- self._file_length = self._file.tell()\r
-\r
- def _pre_mailbox_hook(self, f):\r
- """Called before writing the mailbox to file f."""\r
- f.write('BABYL OPTIONS:%sVersion: 5%sLabels:%s%s\037' %\r
- (os.linesep, os.linesep, ','.join(self.get_labels()),\r
- os.linesep))\r
-\r
- def _pre_message_hook(self, f):\r
- """Called before writing each message to file f."""\r
- f.write('\014' + os.linesep)\r
-\r
- def _post_message_hook(self, f):\r
- """Called after writing each message to file f."""\r
- f.write(os.linesep + '\037')\r
-\r
- def _install_message(self, message):\r
- """Write message contents and return (start, stop)."""\r
- start = self._file.tell()\r
- if isinstance(message, BabylMessage):\r
- special_labels = []\r
- labels = []\r
- for label in message.get_labels():\r
- if label in self._special_labels:\r
- special_labels.append(label)\r
- else:\r
- labels.append(label)\r
- self._file.write('1')\r
- for label in special_labels:\r
- self._file.write(', ' + label)\r
- self._file.write(',,')\r
- for label in labels:\r
- self._file.write(' ' + label + ',')\r
- self._file.write(os.linesep)\r
- else:\r
- self._file.write('1,,' + os.linesep)\r
- if isinstance(message, email.message.Message):\r
- orig_buffer = StringIO.StringIO()\r
- orig_generator = email.generator.Generator(orig_buffer, False, 0)\r
- orig_generator.flatten(message)\r
- orig_buffer.seek(0)\r
- while True:\r
- line = orig_buffer.readline()\r
- self._file.write(line.replace('\n', os.linesep))\r
- if line == '\n' or line == '':\r
- break\r
- self._file.write('*** EOOH ***' + os.linesep)\r
- if isinstance(message, BabylMessage):\r
- vis_buffer = StringIO.StringIO()\r
- vis_generator = email.generator.Generator(vis_buffer, False, 0)\r
- vis_generator.flatten(message.get_visible())\r
- while True:\r
- line = vis_buffer.readline()\r
- self._file.write(line.replace('\n', os.linesep))\r
- if line == '\n' or line == '':\r
- break\r
- else:\r
- orig_buffer.seek(0)\r
- while True:\r
- line = orig_buffer.readline()\r
- self._file.write(line.replace('\n', os.linesep))\r
- if line == '\n' or line == '':\r
- break\r
- while True:\r
- buffer = orig_buffer.read(4096) # Buffer size is arbitrary.\r
- if buffer == '':\r
- break\r
- self._file.write(buffer.replace('\n', os.linesep))\r
- elif isinstance(message, str):\r
- body_start = message.find('\n\n') + 2\r
- if body_start - 2 != -1:\r
- self._file.write(message[:body_start].replace('\n',\r
- os.linesep))\r
- self._file.write('*** EOOH ***' + os.linesep)\r
- self._file.write(message[:body_start].replace('\n',\r
- os.linesep))\r
- self._file.write(message[body_start:].replace('\n',\r
- os.linesep))\r
- else:\r
- self._file.write('*** EOOH ***' + os.linesep + os.linesep)\r
- self._file.write(message.replace('\n', os.linesep))\r
- elif hasattr(message, 'readline'):\r
- original_pos = message.tell()\r
- first_pass = True\r
- while True:\r
- line = message.readline()\r
- self._file.write(line.replace('\n', os.linesep))\r
- if line == '\n' or line == '':\r
- self._file.write('*** EOOH ***' + os.linesep)\r
- if first_pass:\r
- first_pass = False\r
- message.seek(original_pos)\r
- else:\r
- break\r
- while True:\r
- buffer = message.read(4096) # Buffer size is arbitrary.\r
- if buffer == '':\r
- break\r
- self._file.write(buffer.replace('\n', os.linesep))\r
- else:\r
- raise TypeError('Invalid message type: %s' % type(message))\r
- stop = self._file.tell()\r
- return (start, stop)\r
-\r
-\r
-class Message(email.message.Message):\r
- """Message with mailbox-format-specific properties."""\r
-\r
- def __init__(self, message=None):\r
- """Initialize a Message instance."""\r
- if isinstance(message, email.message.Message):\r
- self._become_message(copy.deepcopy(message))\r
- if isinstance(message, Message):\r
- message._explain_to(self)\r
- elif isinstance(message, str):\r
- self._become_message(email.message_from_string(message))\r
- elif hasattr(message, "read"):\r
- self._become_message(email.message_from_file(message))\r
- elif message is None:\r
- email.message.Message.__init__(self)\r
- else:\r
- raise TypeError('Invalid message type: %s' % type(message))\r
-\r
- def _become_message(self, message):\r
- """Assume the non-format-specific state of message."""\r
- for name in ('_headers', '_unixfrom', '_payload', '_charset',\r
- 'preamble', 'epilogue', 'defects', '_default_type'):\r
- self.__dict__[name] = message.__dict__[name]\r
-\r
- def _explain_to(self, message):\r
- """Copy format-specific state to message insofar as possible."""\r
- if isinstance(message, Message):\r
- return # There's nothing format-specific to explain.\r
- else:\r
- raise TypeError('Cannot convert to specified type')\r
-\r
-\r
-class MaildirMessage(Message):\r
- """Message with Maildir-specific properties."""\r
-\r
- def __init__(self, message=None):\r
- """Initialize a MaildirMessage instance."""\r
- self._subdir = 'new'\r
- self._info = ''\r
- self._date = time.time()\r
- Message.__init__(self, message)\r
-\r
- def get_subdir(self):\r
- """Return 'new' or 'cur'."""\r
- return self._subdir\r
-\r
- def set_subdir(self, subdir):\r
- """Set subdir to 'new' or 'cur'."""\r
- if subdir == 'new' or subdir == 'cur':\r
- self._subdir = subdir\r
- else:\r
- raise ValueError("subdir must be 'new' or 'cur': %s" % subdir)\r
-\r
- def get_flags(self):\r
- """Return as a string the flags that are set."""\r
- if self._info.startswith('2,'):\r
- return self._info[2:]\r
- else:\r
- return ''\r
-\r
- def set_flags(self, flags):\r
- """Set the given flags and unset all others."""\r
- self._info = '2,' + ''.join(sorted(flags))\r
-\r
- def add_flag(self, flag):\r
- """Set the given flag(s) without changing others."""\r
- self.set_flags(''.join(set(self.get_flags()) | set(flag)))\r
-\r
- def remove_flag(self, flag):\r
- """Unset the given string flag(s) without changing others."""\r
- if self.get_flags() != '':\r
- self.set_flags(''.join(set(self.get_flags()) - set(flag)))\r
-\r
- def get_date(self):\r
- """Return delivery date of message, in seconds since the epoch."""\r
- return self._date\r
-\r
- def set_date(self, date):\r
- """Set delivery date of message, in seconds since the epoch."""\r
- try:\r
- self._date = float(date)\r
- except ValueError:\r
- raise TypeError("can't convert to float: %s" % date)\r
-\r
- def get_info(self):\r
- """Get the message's "info" as a string."""\r
- return self._info\r
-\r
- def set_info(self, info):\r
- """Set the message's "info" string."""\r
- if isinstance(info, str):\r
- self._info = info\r
- else:\r
- raise TypeError('info must be a string: %s' % type(info))\r
-\r
- def _explain_to(self, message):\r
- """Copy Maildir-specific state to message insofar as possible."""\r
- if isinstance(message, MaildirMessage):\r
- message.set_flags(self.get_flags())\r
- message.set_subdir(self.get_subdir())\r
- message.set_date(self.get_date())\r
- elif isinstance(message, _mboxMMDFMessage):\r
- flags = set(self.get_flags())\r
- if 'S' in flags:\r
- message.add_flag('R')\r
- if self.get_subdir() == 'cur':\r
- message.add_flag('O')\r
- if 'T' in flags:\r
- message.add_flag('D')\r
- if 'F' in flags:\r
- message.add_flag('F')\r
- if 'R' in flags:\r
- message.add_flag('A')\r
- message.set_from('MAILER-DAEMON', time.gmtime(self.get_date()))\r
- elif isinstance(message, MHMessage):\r
- flags = set(self.get_flags())\r
- if 'S' not in flags:\r
- message.add_sequence('unseen')\r
- if 'R' in flags:\r
- message.add_sequence('replied')\r
- if 'F' in flags:\r
- message.add_sequence('flagged')\r
- elif isinstance(message, BabylMessage):\r
- flags = set(self.get_flags())\r
- if 'S' not in flags:\r
- message.add_label('unseen')\r
- if 'T' in flags:\r
- message.add_label('deleted')\r
- if 'R' in flags:\r
- message.add_label('answered')\r
- if 'P' in flags:\r
- message.add_label('forwarded')\r
- elif isinstance(message, Message):\r
- pass\r
- else:\r
- raise TypeError('Cannot convert to specified type: %s' %\r
- type(message))\r
-\r
-\r
-class _mboxMMDFMessage(Message):\r
- """Message with mbox- or MMDF-specific properties."""\r
-\r
- def __init__(self, message=None):\r
- """Initialize an mboxMMDFMessage instance."""\r
- self.set_from('MAILER-DAEMON', True)\r
- if isinstance(message, email.message.Message):\r
- unixfrom = message.get_unixfrom()\r
- if unixfrom is not None and unixfrom.startswith('From '):\r
- self.set_from(unixfrom[5:])\r
- Message.__init__(self, message)\r
-\r
- def get_from(self):\r
- """Return contents of "From " line."""\r
- return self._from\r
-\r
- def set_from(self, from_, time_=None):\r
- """Set "From " line, formatting and appending time_ if specified."""\r
- if time_ is not None:\r
- if time_ is True:\r
- time_ = time.gmtime()\r
- from_ += ' ' + time.asctime(time_)\r
- self._from = from_\r
-\r
- def get_flags(self):\r
- """Return as a string the flags that are set."""\r
- return self.get('Status', '') + self.get('X-Status', '')\r
-\r
- def set_flags(self, flags):\r
- """Set the given flags and unset all others."""\r
- flags = set(flags)\r
- status_flags, xstatus_flags = '', ''\r
- for flag in ('R', 'O'):\r
- if flag in flags:\r
- status_flags += flag\r
- flags.remove(flag)\r
- for flag in ('D', 'F', 'A'):\r
- if flag in flags:\r
- xstatus_flags += flag\r
- flags.remove(flag)\r
- xstatus_flags += ''.join(sorted(flags))\r
- try:\r
- self.replace_header('Status', status_flags)\r
- except KeyError:\r
- self.add_header('Status', status_flags)\r
- try:\r
- self.replace_header('X-Status', xstatus_flags)\r
- except KeyError:\r
- self.add_header('X-Status', xstatus_flags)\r
-\r
- def add_flag(self, flag):\r
- """Set the given flag(s) without changing others."""\r
- self.set_flags(''.join(set(self.get_flags()) | set(flag)))\r
-\r
- def remove_flag(self, flag):\r
- """Unset the given string flag(s) without changing others."""\r
- if 'Status' in self or 'X-Status' in self:\r
- self.set_flags(''.join(set(self.get_flags()) - set(flag)))\r
-\r
- def _explain_to(self, message):\r
- """Copy mbox- or MMDF-specific state to message insofar as possible."""\r
- if isinstance(message, MaildirMessage):\r
- flags = set(self.get_flags())\r
- if 'O' in flags:\r
- message.set_subdir('cur')\r
- if 'F' in flags:\r
- message.add_flag('F')\r
- if 'A' in flags:\r
- message.add_flag('R')\r
- if 'R' in flags:\r
- message.add_flag('S')\r
- if 'D' in flags:\r
- message.add_flag('T')\r
- del message['status']\r
- del message['x-status']\r
- maybe_date = ' '.join(self.get_from().split()[-5:])\r
- try:\r
- message.set_date(calendar.timegm(time.strptime(maybe_date,\r
- '%a %b %d %H:%M:%S %Y')))\r
- except (ValueError, OverflowError):\r
- pass\r
- elif isinstance(message, _mboxMMDFMessage):\r
- message.set_flags(self.get_flags())\r
- message.set_from(self.get_from())\r
- elif isinstance(message, MHMessage):\r
- flags = set(self.get_flags())\r
- if 'R' not in flags:\r
- message.add_sequence('unseen')\r
- if 'A' in flags:\r
- message.add_sequence('replied')\r
- if 'F' in flags:\r
- message.add_sequence('flagged')\r
- del message['status']\r
- del message['x-status']\r
- elif isinstance(message, BabylMessage):\r
- flags = set(self.get_flags())\r
- if 'R' not in flags:\r
- message.add_label('unseen')\r
- if 'D' in flags:\r
- message.add_label('deleted')\r
- if 'A' in flags:\r
- message.add_label('answered')\r
- del message['status']\r
- del message['x-status']\r
- elif isinstance(message, Message):\r
- pass\r
- else:\r
- raise TypeError('Cannot convert to specified type: %s' %\r
- type(message))\r
-\r
-\r
-class mboxMessage(_mboxMMDFMessage):\r
- """Message with mbox-specific properties."""\r
-\r
-\r
-class MHMessage(Message):\r
- """Message with MH-specific properties."""\r
-\r
- def __init__(self, message=None):\r
- """Initialize an MHMessage instance."""\r
- self._sequences = []\r
- Message.__init__(self, message)\r
-\r
- def get_sequences(self):\r
- """Return a list of sequences that include the message."""\r
- return self._sequences[:]\r
-\r
- def set_sequences(self, sequences):\r
- """Set the list of sequences that include the message."""\r
- self._sequences = list(sequences)\r
-\r
- def add_sequence(self, sequence):\r
- """Add sequence to list of sequences including the message."""\r
- if isinstance(sequence, str):\r
- if not sequence in self._sequences:\r
- self._sequences.append(sequence)\r
- else:\r
- raise TypeError('sequence must be a string: %s' % type(sequence))\r
-\r
- def remove_sequence(self, sequence):\r
- """Remove sequence from the list of sequences including the message."""\r
- try:\r
- self._sequences.remove(sequence)\r
- except ValueError:\r
- pass\r
-\r
- def _explain_to(self, message):\r
- """Copy MH-specific state to message insofar as possible."""\r
- if isinstance(message, MaildirMessage):\r
- sequences = set(self.get_sequences())\r
- if 'unseen' in sequences:\r
- message.set_subdir('cur')\r
- else:\r
- message.set_subdir('cur')\r
- message.add_flag('S')\r
- if 'flagged' in sequences:\r
- message.add_flag('F')\r
- if 'replied' in sequences:\r
- message.add_flag('R')\r
- elif isinstance(message, _mboxMMDFMessage):\r
- sequences = set(self.get_sequences())\r
- if 'unseen' not in sequences:\r
- message.add_flag('RO')\r
- else:\r
- message.add_flag('O')\r
- if 'flagged' in sequences:\r
- message.add_flag('F')\r
- if 'replied' in sequences:\r
- message.add_flag('A')\r
- elif isinstance(message, MHMessage):\r
- for sequence in self.get_sequences():\r
- message.add_sequence(sequence)\r
- elif isinstance(message, BabylMessage):\r
- sequences = set(self.get_sequences())\r
- if 'unseen' in sequences:\r
- message.add_label('unseen')\r
- if 'replied' in sequences:\r
- message.add_label('answered')\r
- elif isinstance(message, Message):\r
- pass\r
- else:\r
- raise TypeError('Cannot convert to specified type: %s' %\r
- type(message))\r
-\r
-\r
-class BabylMessage(Message):\r
- """Message with Babyl-specific properties."""\r
-\r
- def __init__(self, message=None):\r
- """Initialize an BabylMessage instance."""\r
- self._labels = []\r
- self._visible = Message()\r
- Message.__init__(self, message)\r
-\r
- def get_labels(self):\r
- """Return a list of labels on the message."""\r
- return self._labels[:]\r
-\r
- def set_labels(self, labels):\r
- """Set the list of labels on the message."""\r
- self._labels = list(labels)\r
-\r
- def add_label(self, label):\r
- """Add label to list of labels on the message."""\r
- if isinstance(label, str):\r
- if label not in self._labels:\r
- self._labels.append(label)\r
- else:\r
- raise TypeError('label must be a string: %s' % type(label))\r
-\r
- def remove_label(self, label):\r
- """Remove label from the list of labels on the message."""\r
- try:\r
- self._labels.remove(label)\r
- except ValueError:\r
- pass\r
-\r
- def get_visible(self):\r
- """Return a Message representation of visible headers."""\r
- return Message(self._visible)\r
-\r
- def set_visible(self, visible):\r
- """Set the Message representation of visible headers."""\r
- self._visible = Message(visible)\r
-\r
- def update_visible(self):\r
- """Update and/or sensibly generate a set of visible headers."""\r
- for header in self._visible.keys():\r
- if header in self:\r
- self._visible.replace_header(header, self[header])\r
- else:\r
- del self._visible[header]\r
- for header in ('Date', 'From', 'Reply-To', 'To', 'CC', 'Subject'):\r
- if header in self and header not in self._visible:\r
- self._visible[header] = self[header]\r
-\r
- def _explain_to(self, message):\r
- """Copy Babyl-specific state to message insofar as possible."""\r
- if isinstance(message, MaildirMessage):\r
- labels = set(self.get_labels())\r
- if 'unseen' in labels:\r
- message.set_subdir('cur')\r
- else:\r
- message.set_subdir('cur')\r
- message.add_flag('S')\r
- if 'forwarded' in labels or 'resent' in labels:\r
- message.add_flag('P')\r
- if 'answered' in labels:\r
- message.add_flag('R')\r
- if 'deleted' in labels:\r
- message.add_flag('T')\r
- elif isinstance(message, _mboxMMDFMessage):\r
- labels = set(self.get_labels())\r
- if 'unseen' not in labels:\r
- message.add_flag('RO')\r
- else:\r
- message.add_flag('O')\r
- if 'deleted' in labels:\r
- message.add_flag('D')\r
- if 'answered' in labels:\r
- message.add_flag('A')\r
- elif isinstance(message, MHMessage):\r
- labels = set(self.get_labels())\r
- if 'unseen' in labels:\r
- message.add_sequence('unseen')\r
- if 'answered' in labels:\r
- message.add_sequence('replied')\r
- elif isinstance(message, BabylMessage):\r
- message.set_visible(self.get_visible())\r
- for label in self.get_labels():\r
- message.add_label(label)\r
- elif isinstance(message, Message):\r
- pass\r
- else:\r
- raise TypeError('Cannot convert to specified type: %s' %\r
- type(message))\r
-\r
-\r
-class MMDFMessage(_mboxMMDFMessage):\r
- """Message with MMDF-specific properties."""\r
-\r
-\r
-class _ProxyFile:\r
- """A read-only wrapper of a file."""\r
-\r
- def __init__(self, f, pos=None):\r
- """Initialize a _ProxyFile."""\r
- self._file = f\r
- if pos is None:\r
- self._pos = f.tell()\r
- else:\r
- self._pos = pos\r
-\r
- def read(self, size=None):\r
- """Read bytes."""\r
- return self._read(size, self._file.read)\r
-\r
- def readline(self, size=None):\r
- """Read a line."""\r
- return self._read(size, self._file.readline)\r
-\r
- def readlines(self, sizehint=None):\r
- """Read multiple lines."""\r
- result = []\r
- for line in self:\r
- result.append(line)\r
- if sizehint is not None:\r
- sizehint -= len(line)\r
- if sizehint <= 0:\r
- break\r
- return result\r
-\r
- def __iter__(self):\r
- """Iterate over lines."""\r
- return iter(self.readline, "")\r
-\r
- def tell(self):\r
- """Return the position."""\r
- return self._pos\r
-\r
- def seek(self, offset, whence=0):\r
- """Change position."""\r
- if whence == 1:\r
- self._file.seek(self._pos)\r
- self._file.seek(offset, whence)\r
- self._pos = self._file.tell()\r
-\r
- def close(self):\r
- """Close the file."""\r
- del self._file\r
-\r
- def _read(self, size, read_method):\r
- """Read size bytes using read_method."""\r
- if size is None:\r
- size = -1\r
- self._file.seek(self._pos)\r
- result = read_method(size)\r
- self._pos = self._file.tell()\r
- return result\r
-\r
-\r
-class _PartialFile(_ProxyFile):\r
- """A read-only wrapper of part of a file."""\r
-\r
- def __init__(self, f, start=None, stop=None):\r
- """Initialize a _PartialFile."""\r
- _ProxyFile.__init__(self, f, start)\r
- self._start = start\r
- self._stop = stop\r
-\r
- def tell(self):\r
- """Return the position with respect to start."""\r
- return _ProxyFile.tell(self) - self._start\r
-\r
- def seek(self, offset, whence=0):\r
- """Change position, possibly with respect to start or stop."""\r
- if whence == 0:\r
- self._pos = self._start\r
- whence = 1\r
- elif whence == 2:\r
- self._pos = self._stop\r
- whence = 1\r
- _ProxyFile.seek(self, offset, whence)\r
-\r
- def _read(self, size, read_method):\r
- """Read size bytes using read_method, honoring start and stop."""\r
- remaining = self._stop - self._pos\r
- if remaining <= 0:\r
- return ''\r
- if size is None or size < 0 or size > remaining:\r
- size = remaining\r
- return _ProxyFile._read(self, size, read_method)\r
-\r
-\r
-def _lock_file(f, dotlock=True):\r
- """Lock file f using lockf and dot locking."""\r
- dotlock_done = False\r
- try:\r
- if fcntl:\r
- try:\r
- fcntl.lockf(f, fcntl.LOCK_EX | fcntl.LOCK_NB)\r
- except IOError, e:\r
- if e.errno in (errno.EAGAIN, errno.EACCES, errno.EROFS):\r
- raise ExternalClashError('lockf: lock unavailable: %s' %\r
- f.name)\r
- else:\r
- raise\r
- if dotlock:\r
- try:\r
- pre_lock = _create_temporary(f.name + '.lock')\r
- pre_lock.close()\r
- except IOError, e:\r
- if e.errno in (errno.EACCES, errno.EROFS):\r
- return # Without write access, just skip dotlocking.\r
- else:\r
- raise\r
- try:\r
- if hasattr(os, 'link'):\r
- os.link(pre_lock.name, f.name + '.lock')\r
- dotlock_done = True\r
- os.unlink(pre_lock.name)\r
- else:\r
- os.rename(pre_lock.name, f.name + '.lock')\r
- dotlock_done = True\r
- except OSError, e:\r
- if e.errno == errno.EEXIST or \\r
- (os.name == 'os2' and e.errno == errno.EACCES):\r
- os.remove(pre_lock.name)\r
- raise ExternalClashError('dot lock unavailable: %s' %\r
- f.name)\r
- else:\r
- raise\r
- except:\r
- if fcntl:\r
- fcntl.lockf(f, fcntl.LOCK_UN)\r
- if dotlock_done:\r
- os.remove(f.name + '.lock')\r
- raise\r
-\r
-def _unlock_file(f):\r
- """Unlock file f using lockf and dot locking."""\r
- if fcntl:\r
- fcntl.lockf(f, fcntl.LOCK_UN)\r
- if os.path.exists(f.name + '.lock'):\r
- os.remove(f.name + '.lock')\r
-\r
-def _create_carefully(path):\r
- """Create a file if it doesn't exist and open for reading and writing."""\r
- fd = os.open(path, os.O_CREAT | os.O_EXCL | os.O_RDWR, 0666)\r
- try:\r
- return open(path, 'rb+')\r
- finally:\r
- os.close(fd)\r
-\r
-def _create_temporary(path):\r
- """Create a temp file based on path and open for reading and writing."""\r
- return _create_carefully('%s.%s.%s.%s' % (path, int(time.time()),\r
- socket.gethostname(),\r
- os.getpid()))\r
-\r
-def _sync_flush(f):\r
- """Ensure changes to file f are physically on disk."""\r
- f.flush()\r
- if hasattr(os, 'fsync'):\r
- os.fsync(f.fileno())\r
-\r
-def _sync_close(f):\r
- """Close file f, ensuring all changes are physically on disk."""\r
- _sync_flush(f)\r
- f.close()\r
-\r
-## Start: classes from the original module (for backward compatibility).\r
-\r
-# Note that the Maildir class, whose name is unchanged, itself offers a next()\r
-# method for backward compatibility.\r
-\r
-class _Mailbox:\r
-\r
- def __init__(self, fp, factory=rfc822.Message):\r
- self.fp = fp\r
- self.seekp = 0\r
- self.factory = factory\r
-\r
- def __iter__(self):\r
- return iter(self.next, None)\r
-\r
- def next(self):\r
- while 1:\r
- self.fp.seek(self.seekp)\r
- try:\r
- self._search_start()\r
- except EOFError:\r
- self.seekp = self.fp.tell()\r
- return None\r
- start = self.fp.tell()\r
- self._search_end()\r
- self.seekp = stop = self.fp.tell()\r
- if start != stop:\r
- break\r
- return self.factory(_PartialFile(self.fp, start, stop))\r
-\r
-# Recommended to use PortableUnixMailbox instead!\r
-class UnixMailbox(_Mailbox):\r
-\r
- def _search_start(self):\r
- while 1:\r
- pos = self.fp.tell()\r
- line = self.fp.readline()\r
- if not line:\r
- raise EOFError\r
- if line[:5] == 'From ' and self._isrealfromline(line):\r
- self.fp.seek(pos)\r
- return\r
-\r
- def _search_end(self):\r
- self.fp.readline() # Throw away header line\r
- while 1:\r
- pos = self.fp.tell()\r
- line = self.fp.readline()\r
- if not line:\r
- return\r
- if line[:5] == 'From ' and self._isrealfromline(line):\r
- self.fp.seek(pos)\r
- return\r
-\r
- # An overridable mechanism to test for From-line-ness. You can either\r
- # specify a different regular expression or define a whole new\r
- # _isrealfromline() method. Note that this only gets called for lines\r
- # starting with the 5 characters "From ".\r
- #\r
- # BAW: According to\r
- #http://home.netscape.com/eng/mozilla/2.0/relnotes/demo/content-length.html\r
- # the only portable, reliable way to find message delimiters in a BSD (i.e\r
- # Unix mailbox) style folder is to search for "\n\nFrom .*\n", or at the\r
- # beginning of the file, "^From .*\n". While _fromlinepattern below seems\r
- # like a good idea, in practice, there are too many variations for more\r
- # strict parsing of the line to be completely accurate.\r
- #\r
- # _strict_isrealfromline() is the old version which tries to do stricter\r
- # parsing of the From_ line. _portable_isrealfromline() simply returns\r
- # true, since it's never called if the line doesn't already start with\r
- # "From ".\r
- #\r
- # This algorithm, and the way it interacts with _search_start() and\r
- # _search_end() may not be completely correct, because it doesn't check\r
- # that the two characters preceding "From " are \n\n or the beginning of\r
- # the file. Fixing this would require a more extensive rewrite than is\r
- # necessary. For convenience, we've added a PortableUnixMailbox class\r
- # which does no checking of the format of the 'From' line.\r
-\r
- _fromlinepattern = (r"From \s*[^\s]+\s+\w\w\w\s+\w\w\w\s+\d?\d\s+"\r
- r"\d?\d:\d\d(:\d\d)?(\s+[^\s]+)?\s+\d\d\d\d\s*"\r
- r"[^\s]*\s*"\r
- "$")\r
- _regexp = None\r
-\r
- def _strict_isrealfromline(self, line):\r
- if not self._regexp:\r
- import re\r
- self._regexp = re.compile(self._fromlinepattern)\r
- return self._regexp.match(line)\r
-\r
- def _portable_isrealfromline(self, line):\r
- return True\r
-\r
- _isrealfromline = _strict_isrealfromline\r
-\r
-\r
-class PortableUnixMailbox(UnixMailbox):\r
- _isrealfromline = UnixMailbox._portable_isrealfromline\r
-\r
-\r
-class MmdfMailbox(_Mailbox):\r
-\r
- def _search_start(self):\r
- while 1:\r
- line = self.fp.readline()\r
- if not line:\r
- raise EOFError\r
- if line[:5] == '\001\001\001\001\n':\r
- return\r
-\r
- def _search_end(self):\r
- while 1:\r
- pos = self.fp.tell()\r
- line = self.fp.readline()\r
- if not line:\r
- return\r
- if line == '\001\001\001\001\n':\r
- self.fp.seek(pos)\r
- return\r
-\r
-\r
-class MHMailbox:\r
-\r
- def __init__(self, dirname, factory=rfc822.Message):\r
- import re\r
- pat = re.compile('^[1-9][0-9]*$')\r
- self.dirname = dirname\r
- # the three following lines could be combined into:\r
- # list = map(long, filter(pat.match, os.listdir(self.dirname)))\r
- list = os.listdir(self.dirname)\r
- list = filter(pat.match, list)\r
- list = map(long, list)\r
- list.sort()\r
- # This only works in Python 1.6 or later;\r
- # before that str() added 'L':\r
- self.boxes = map(str, list)\r
- self.boxes.reverse()\r
- self.factory = factory\r
-\r
- def __iter__(self):\r
- return iter(self.next, None)\r
-\r
- def next(self):\r
- if not self.boxes:\r
- return None\r
- fn = self.boxes.pop()\r
- fp = open(os.path.join(self.dirname, fn))\r
- msg = self.factory(fp)\r
- try:\r
- msg._mh_msgno = fn\r
- except (AttributeError, TypeError):\r
- pass\r
- return msg\r
-\r
-\r
-class BabylMailbox(_Mailbox):\r
-\r
- def _search_start(self):\r
- while 1:\r
- line = self.fp.readline()\r
- if not line:\r
- raise EOFError\r
- if line == '*** EOOH ***\n':\r
- return\r
-\r
- def _search_end(self):\r
- while 1:\r
- pos = self.fp.tell()\r
- line = self.fp.readline()\r
- if not line:\r
- return\r
- if line == '\037\014\n' or line == '\037':\r
- self.fp.seek(pos)\r
- return\r
-\r
-## End: classes from the original module (for backward compatibility).\r
-\r
-\r
-class Error(Exception):\r
- """Raised for module-specific errors."""\r
-\r
-class NoSuchMailboxError(Error):\r
- """The specified mailbox does not exist and won't be created."""\r
-\r
-class NotEmptyError(Error):\r
- """The specified mailbox is not empty and deletion was requested."""\r
-\r
-class ExternalClashError(Error):\r
- """Another process caused an action to fail."""\r
-\r
-class FormatError(Error):\r
- """A file appears to have an invalid format."""\r